Package edu.umd.cs.findbugs.anttask

Class FindBugsViewerTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

edu.umd.cs.findbugs.anttask.FindBugsViewerTask

public class FindBugsViewerTask
extends org.apache.tools.ant.Task

FindBugsViewerTask.java -- Ant Task to launch the FindBugsFrame To use, create a new task that refrences the ant task (such as "findbugs-viewer"). Then call this task while passing in parameters to modify it's behaviour. It supports several options that are the same as the findbugs task: -projectFile -debug -jvmargs -home -classpath -pluginList -timeout It also adds some new options: -look: string name representing look and feel. Can be "native", "plastic" or "gtk" -loadbugs: file name of bug report to load The below is an example of how this could be done in an ant script: Created on March 21, 2006, 12:57 PM

Author:

Mark McKay, mark@kitfox.com

Field Summary

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Constructor Summary

Constructors

Constructor	Description
FindBugsViewerTask()	Creates a new instance of FindBugsViewerTask

Method Summary

Modifier and Type	Method	Description
org.apache.tools.ant.types.Path	createClasspath()	Path to use for classpath.
org.apache.tools.ant.types.Path	createPluginList()	Path to use for plugin list.
void	execute()
void	setClasspathRef(org.apache.tools.ant.taskdefs.Ant.Reference r)	Adds a reference to a classpath defined elsewhere.
void	setDebug(boolean flag)	Set the debug flag
void	setHome(java.io.File homeDir)	Set the home directory into which findbugs was installed
void	setJvmargs(java.lang.String args)	Set any specific jvm args
void	setLoadbugs(java.io.File loadbugs)	Sets the file that contains the XML output of a findbugs report.
void	setLook(java.lang.String look)	Set look.
void	setPluginList(org.apache.tools.ant.types.Path src)	the plugin list to use.
void	setPluginListRef(org.apache.tools.ant.taskdefs.Ant.Reference r)	Adds a reference to a plugin list defined elsewhere.
void	setProjectFile(java.io.File projectFile)	Set the project file
void	setTimeout(long timeout)	Set timeout in milliseconds.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Constructor Detail

FindBugsViewerTask

public FindBugsViewerTask()

Creates a new instance of FindBugsViewerTask

Method Detail

setLoadbugs

public void setLoadbugs(java.io.File loadbugs)

Sets the file that contains the XML output of a findbugs report.

Parameters:

loadbugs - XML output from a findbugs session

setProjectFile

public void setProjectFile(java.io.File projectFile)

Set the project file

setDebug

public void setDebug(boolean flag)

Set the debug flag

setJvmargs

public void setJvmargs(java.lang.String args)

Set any specific jvm args

setLook

public void setLook(java.lang.String look)

Set look. One of "native", "gtk" or "plastic"

setHome

public void setHome(java.io.File homeDir)

Set the home directory into which findbugs was installed

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

Path to use for classpath.

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.taskdefs.Ant.Reference r)

Adds a reference to a classpath defined elsewhere.

setPluginList

public void setPluginList(org.apache.tools.ant.types.Path src)

the plugin list to use.

createPluginList

public org.apache.tools.ant.types.Path createPluginList()

Path to use for plugin list.

setPluginListRef

public void setPluginListRef(org.apache.tools.ant.taskdefs.Ant.Reference r)

Adds a reference to a plugin list defined elsewhere.

setTimeout

public void setTimeout(long timeout)

Set timeout in milliseconds.

Parameters:

timeout - the timeout

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException