Package edu.umd.cs.findbugs.anttask
Class AbstractFindBugsTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
edu.umd.cs.findbugs.anttask.AbstractFindBugsTask
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
ComputeBugHistoryTask
,ConvertXmlToTextTask
,FilterBugsTask
,FindBugsTask
,MineBugHistoryTask
,SetBugDatabaseInfoTask
,UnionBugs2
public abstract class AbstractFindBugsTask
extends org.apache.tools.ant.Task
Abstract base class for Ant tasks that run programs (main() methods) in
findbugs.jar or findbugsGUI.jar.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.tools.ant.types.Path
private boolean
static final long
protected String
private boolean
static final String
private org.apache.tools.ant.taskdefs.Java
private File
private String
private String
private final String
private org.apache.tools.ant.types.Path
static final String
private final List
<AbstractFindBugsTask.SystemProperty> private long
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Add an argument to the JVM used to execute FindBugs.protected void
afterExecuteJavaProcess
(int rc) protected abstract void
protected void
Check that all required attributes have been set.protected abstract void
org.apache.tools.ant.types.Path
Path to use for classpath.protected void
Create the FindBugs engine (the Java process that will run whatever FindBugs-related program this task is going to execute).org.apache.tools.ant.types.Path
Path to use for plugin list.Create a SystemProperty (to handle <systemProperty> elements).private void
Create a new JVM to do the work.void
execute()
protected boolean
getDebug()
Get the debug flag.protected org.apache.tools.ant.taskdefs.Java
Get the Findbugs engine.void
setClasspath
(org.apache.tools.ant.types.Path src) Set the classpath to use.void
setClasspathRef
(org.apache.tools.ant.types.Reference r) Adds a reference to a classpath defined elsewhere.void
setDebug
(boolean flag) Set the debug flagvoid
setErrorProperty
(String name) Tells this task to set the property with the given name to "true" when there were errors.void
setFailOnError
(boolean flag) Set the failOnError flagvoid
Set the home directory into which spotbugs was installedprotected void
setInputString
(String input) Sets the given string to be piped to standard input of the FindBugs JVM upon launching.void
Set the command used to start the VMvoid
setJvmargs
(String args) Set any specific jvm argsvoid
setPluginList
(org.apache.tools.ant.types.Path src) the plugin list to use.void
setPluginListRef
(org.apache.tools.ant.types.Reference r) Adds a reference to a plugin list defined elsewhere.void
setTimeout
(long timeout) Set timeout in milliseconds.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
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
FINDBUGS_JAR
- See Also:
-
DEFAULT_TIMEOUT
public static final long DEFAULT_TIMEOUT- See Also:
-
RESULT_PROPERTY_SUFFIX
- See Also:
-
mainClass
-
debug
private boolean debug -
homeDir
-
jvm
-
jvmargs
-
timeout
private long timeout -
failOnError
private boolean failOnError -
errorProperty
-
systemPropertyList
-
classpath
private org.apache.tools.ant.types.Path classpath -
pluginList
private org.apache.tools.ant.types.Path pluginList -
findbugsEngine
private org.apache.tools.ant.taskdefs.Java findbugsEngine -
execResultProperty
-
-
Constructor Details
-
AbstractFindBugsTask
Constructor.
-
-
Method Details
-
setHome
Set the home directory into which spotbugs was installed- Parameters:
homeDir
- installation directory
-
setDebug
public void setDebug(boolean flag) Set the debug flag- Parameters:
flag
-true
to enable debugging
-
getDebug
protected boolean getDebug()Get the debug flag. -
setJvmargs
Set any specific jvm args- Parameters:
args
- JVM arguments
-
setJvm
Set the command used to start the VM- Parameters:
jvm
- command used to start the VM
-
setTimeout
public void setTimeout(long timeout) Set timeout in milliseconds.- Parameters:
timeout
- the timeout
-
setFailOnError
public void setFailOnError(boolean flag) Set the failOnError flag- Parameters:
flag
-true
to enable
-
setErrorProperty
Tells this task to set the property with the given name to "true" when there were errors.- Parameters:
name
- property to set to "true" on errors
-
createSystemProperty
Create a SystemProperty (to handle <systemProperty> elements).- Returns:
- new property
-
setClasspath
public void setClasspath(org.apache.tools.ant.types.Path src) Set the classpath to use.- Parameters:
src
- classpath to use
-
createClasspath
public org.apache.tools.ant.types.Path createClasspath()Path to use for classpath.- Returns:
- path to use for classpath
-
setClasspathRef
public void setClasspathRef(org.apache.tools.ant.types.Reference r) Adds a reference to a classpath defined elsewhere.- Parameters:
r
- reference to a classpath defined elsewhere
-
setPluginList
public void setPluginList(org.apache.tools.ant.types.Path src) the plugin list to use.- Parameters:
src
- plugin list to use
-
createPluginList
public org.apache.tools.ant.types.Path createPluginList()Path to use for plugin list.- Returns:
- path to use for plugin list
-
setPluginListRef
public void setPluginListRef(org.apache.tools.ant.types.Reference r) Adds a reference to a plugin list defined elsewhere.- Parameters:
r
- reference to a plugin list defined elsewhere
-
execute
public void execute() throws org.apache.tools.ant.BuildException- Overrides:
execute
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
-
checkParameters
protected void checkParameters()Check that all required attributes have been set. -
createFindbugsEngine
protected void createFindbugsEngine()Create the FindBugs engine (the Java process that will run whatever FindBugs-related program this task is going to execute). -
getFindbugsEngine
protected org.apache.tools.ant.taskdefs.Java getFindbugsEngine()Get the Findbugs engine. -
addArg
Add an argument to the JVM used to execute FindBugs.- Parameters:
arg
- the argument
-
setInputString
Sets the given string to be piped to standard input of the FindBugs JVM upon launching. -
execFindbugs
private void execFindbugs() throws org.apache.tools.ant.BuildExceptionCreate a new JVM to do the work.- Throws:
org.apache.tools.ant.BuildException
- Since:
- Ant 1.5
-
configureFindbugsEngine
protected abstract void configureFindbugsEngine() -
beforeExecuteJavaProcess
protected abstract void beforeExecuteJavaProcess() -
afterExecuteJavaProcess
protected void afterExecuteJavaProcess(int rc)
-