org.schmant.task.findbugs
Class ExtFindbugsTF

java.lang.Object
  org.schmant.task.stub.AbstractTaskFactory<T,U>
      org.schmant.task.template.process.AbstractExtProcessTaskFactory<T,U>
          org.schmant.task.template.jdk.java.AbstractExtJvmTaskFactory<ExtFindbugsTF,ExtFindbugsTask>
              org.schmant.task.findbugs.ExtFindbugsTF

All Implemented Interfaces:

ActionTaskConfigurable<ExtFindbugsTF>, ActionTaskFactory<ExtFindbugsTF,ExtFindbugsTask>, ArgumentsConfigurable<ExtFindbugsTF>, ClasspathConfigurable<ExtFindbugsTF>, LoggingConfigurable<ExtFindbugsTF>, OverwriteConfigurable<ExtFindbugsTF>, SourceConfigurable<ExtFindbugsTF>, TargetConfigurable<ExtFindbugsTF>, FindbugsConfigurable<ExtFindbugsTF>, GeneratorTaskConfigurable<ExtFindbugsTF>, GeneratorTaskFactory<ExtFindbugsTF,ExtFindbugsTask>, ProcessTaskConfigurable<ExtFindbugsTF>, ProcessTaskFactory<ExtFindbugsTF,ExtFindbugsTask>, TaskFactory<ExtFindbugsTF,ExtFindbugsTask>, TaskRunnable, ExtJvmConfigurable<ExtFindbugsTF>, ExtJvmTaskConfigurable<ExtFindbugsTF>, JvmConfigurable<ExtFindbugsTF>, JvmOptionsConfigurable<ExtFindbugsTF>, JavaHomeConfigurable<ExtFindbugsTF>, ExtProcessConfigurable<ExtFindbugsTF>

public final class ExtFindbugsTF
extends AbstractExtJvmTaskFactory<ExtFindbugsTF,ExtFindbugsTask>
implements ProcessTaskFactory<ExtFindbugsTF,ExtFindbugsTask>, FindbugsConfigurable<ExtFindbugsTF>

Factory for ExtFindbugsTask.

See ExtFindbugsTF

Since:

0.5

Author:

Karl Gustafsson

See Also:

ExtFindbugsTask

Task_package:

net.findbugs

Field Summary

Fields inherited from interface org.schmant.task.confable.OverwriteConfigurable

DEFAULT_OVERWRITE_STRATEGY

Constructor Summary

ExtFindbugsTF()

Method Summary

ExtFindbugsTF	addAuxClasspathEntries(Object o)
ExtFindbugsTF	addAuxClasspathEntry(Object o)
ExtFindbugsTF	addSource(Object o) Add one or several sources.
ExtFindbugsTF	addSourceCodeContainer(Object o)
ExtFindbugsTF	addSourceCodeContainers(Object o)
ExtFindbugsTF	addSources(Object o) This method does the same as SourceConfigurable.addSource(Object)
ExtFindbugsTF	addSystemProperties(Object o)
ExtFindbugsTF	addSystemProperty(String name, String value)
ExtFindbugsTF	clearAuxClasspathEntries()
ExtFindbugsTF	clearSourceCodeContainers()
ExtFindbugsTF	clearSources() Clear the collection of sources.
ExtFindbugsTF	clearSystemProperties()
protected ExtFindbugsTask	createSpecification() Subclasses implement this to create the task specification object that this factory uses to configure the task that it is creating.
ExtFindbugsTF	setClassesAndPackagesToAnalyze(String s)
ExtFindbugsTF	setDebug(boolean b)
ExtFindbugsTF	setEffortLevel(FindbugsEffortLevel l)
ExtFindbugsTF	setExcludeFilterFile(Object o)
ExtFindbugsTF	setFindbugsExecutable(Object o)
ExtFindbugsTF	setFindbugsReportFormat(FindbugsReportFormat f)
ExtFindbugsTF	setFindbugsReportLevel(FindbugsReportLevel l)
ExtFindbugsTF	setHtmlStylesheet(String name)
ExtFindbugsTF	setIncludeFilterFile(Object o)
ExtFindbugsTF	setMaxHeapInMegabytes(int n)
ExtFindbugsTF	setNested(boolean b)
ExtFindbugsTF	setOverwrite(boolean b) Should things be overwritten? If this is set to true, it is equivalent to setting the overwrite strategy to DoOverwriteAndLogWarning.
ExtFindbugsTF	setOverwriteStrategy(OverwriteStrategy strat) Set a strategy for how to react to existing entities in locations where the task wants to write.
ExtFindbugsTF	setProjectFile(Object o)
ExtFindbugsTF	setRelativeToBase(RelativeLocation rel) This property is set with the task's source's location relative to a base location if the task is run within a recursive task.
ExtFindbugsTF	setSortByClass(boolean b)
ExtFindbugsTF	setSource(Object o) Set one or several sources, discarding previously set sources.
ExtFindbugsTF	setSources(Object o) This method does the same as SourceConfigurable.setSource(Object)
ExtFindbugsTF	setTarget(Object o) Set the target.
ExtFindbugsTF	setXmlWithMessages(boolean b)

Methods inherited from class org.schmant.task.template.jdk.java.AbstractExtJvmTaskFactory

addClasspathDecorator, addClasspathDecorators, addClasspathEntries, addClasspathEntry, addJvmOption, addJvmOptions, clearClasspathDecorators, clearClasspathEntries, clearJvmOptions, setJavaExecutable, setJavaHome

Methods inherited from class org.schmant.task.template.process.AbstractExtProcessTaskFactory

addArgument, addArguments, addEnvironmentVariable, addEnvironmentVariables, clearArguments, clearEnvironmentVariables, setFailOnErrors, setInheritEnvironmentVariables, setStderrStrategy, setStdoutStrategy, setWorkingDirectory

Methods inherited from class org.schmant.task.stub.AbstractTaskFactory

copy, create, getLastCreated, getSpecification, getThis, run, setLogFooter, setLogHeader, setReportLevel, setTraceLogging, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.schmant.task.TaskFactory

copy, create, getLastCreated, getSpecification

Methods inherited from interface org.schmant.task.confable.LoggingConfigurable

setLogFooter, setLogHeader, setReportLevel, setTraceLogging

Methods inherited from interface org.schmant.task.TaskRunnable

run

Methods inherited from interface org.schmant.task.template.process.ExtProcessConfigurable

addEnvironmentVariable, addEnvironmentVariables, clearEnvironmentVariables, setFailOnErrors, setInheritEnvironmentVariables, setStderrStrategy, setStdoutStrategy, setWorkingDirectory

Methods inherited from interface org.schmant.task.confable.ArgumentsConfigurable

addArgument, addArguments, clearArguments

Constructor Detail

ExtFindbugsTF

public ExtFindbugsTF()

Method Detail

setFindbugsExecutable

public ExtFindbugsTF setFindbugsExecutable(Object o)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

setMaxHeapInMegabytes

public ExtFindbugsTF setMaxHeapInMegabytes(int n)

setDebug

public ExtFindbugsTF setDebug(boolean b)

Specified by:

setDebug in interface FindbugsConfigurable<ExtFindbugsTF>

setEffortLevel

public ExtFindbugsTF setEffortLevel(FindbugsEffortLevel l)

Specified by:

setEffortLevel in interface FindbugsConfigurable<ExtFindbugsTF>

addSystemProperty

public ExtFindbugsTF addSystemProperty(String name,
                                       String value)

addSystemProperties

public ExtFindbugsTF addSystemProperties(Object o)

clearSystemProperties

public ExtFindbugsTF clearSystemProperties()

setProjectFile

public ExtFindbugsTF setProjectFile(Object o)

Specified by:

setProjectFile in interface FindbugsConfigurable<ExtFindbugsTF>

setSortByClass

public ExtFindbugsTF setSortByClass(boolean b)

Specified by:

setSortByClass in interface FindbugsConfigurable<ExtFindbugsTF>

setIncludeFilterFile

public ExtFindbugsTF setIncludeFilterFile(Object o)

Specified by:

setIncludeFilterFile in interface FindbugsConfigurable<ExtFindbugsTF>

setExcludeFilterFile

public ExtFindbugsTF setExcludeFilterFile(Object o)

Specified by:

setExcludeFilterFile in interface FindbugsConfigurable<ExtFindbugsTF>

setClassesAndPackagesToAnalyze

public ExtFindbugsTF setClassesAndPackagesToAnalyze(String s)

Specified by:

setClassesAndPackagesToAnalyze in interface FindbugsConfigurable<ExtFindbugsTF>

setFindbugsReportLevel

public ExtFindbugsTF setFindbugsReportLevel(FindbugsReportLevel l)

Specified by:

setFindbugsReportLevel in interface FindbugsConfigurable<ExtFindbugsTF>

setFindbugsReportFormat

public ExtFindbugsTF setFindbugsReportFormat(FindbugsReportFormat f)

Specified by:

setFindbugsReportFormat in interface FindbugsConfigurable<ExtFindbugsTF>

setXmlWithMessages

public ExtFindbugsTF setXmlWithMessages(boolean b)

Specified by:

setXmlWithMessages in interface FindbugsConfigurable<ExtFindbugsTF>

setHtmlStylesheet

public ExtFindbugsTF setHtmlStylesheet(String name)

Specified by:

setHtmlStylesheet in interface FindbugsConfigurable<ExtFindbugsTF>

setTarget

public ExtFindbugsTF setTarget(Object o)

Description copied from interface: TargetConfigurable

Set the target.

Specified by:

setTarget in interface TargetConfigurable<ExtFindbugsTF>

Parameters:

o - The target.

Returns:

this

setOverwrite

public ExtFindbugsTF setOverwrite(boolean b)

Description copied from interface: OverwriteConfigurable

Should things be overwritten? If this is set to true, it is equivalent to setting the overwrite strategy to DoOverwriteAndLogWarning. If this is set to false, it is equivalent to setting the overwrite strategy to DontOverwriteAndLogWarning.

Specified by:

setOverwrite in interface OverwriteConfigurable<ExtFindbugsTF>

Parameters:

b - Should things be overwritten?

Returns:

this

setOverwriteStrategy

public ExtFindbugsTF setOverwriteStrategy(OverwriteStrategy strat)

Description copied from interface: OverwriteConfigurable

Set a strategy for how to react to existing entities in locations where the task wants to write.

Specified by:

setOverwriteStrategy in interface OverwriteConfigurable<ExtFindbugsTF>

Parameters:

strat - The overwrite strategy.

Returns:

this

setNested

public ExtFindbugsTF setNested(boolean b)

Specified by:

setNested in interface FindbugsConfigurable<ExtFindbugsTF>

addAuxClasspathEntry

public ExtFindbugsTF addAuxClasspathEntry(Object o)

Specified by:

addAuxClasspathEntry in interface FindbugsConfigurable<ExtFindbugsTF>

addAuxClasspathEntries

public ExtFindbugsTF addAuxClasspathEntries(Object o)

Specified by:

addAuxClasspathEntries in interface FindbugsConfigurable<ExtFindbugsTF>

clearAuxClasspathEntries

public ExtFindbugsTF clearAuxClasspathEntries()

Specified by:

clearAuxClasspathEntries in interface FindbugsConfigurable<ExtFindbugsTF>

addSourceCodeContainer

public ExtFindbugsTF addSourceCodeContainer(Object o)

Specified by:

addSourceCodeContainer in interface FindbugsConfigurable<ExtFindbugsTF>

addSourceCodeContainers

public ExtFindbugsTF addSourceCodeContainers(Object o)

Specified by:

addSourceCodeContainers in interface FindbugsConfigurable<ExtFindbugsTF>

clearSourceCodeContainers

public ExtFindbugsTF clearSourceCodeContainers()

Specified by:

clearSourceCodeContainers in interface FindbugsConfigurable<ExtFindbugsTF>

setSource

public ExtFindbugsTF setSource(Object o)

Description copied from interface: SourceConfigurable

Set one or several sources, discarding previously set sources.

Specified by:

setSource in interface SourceConfigurable<ExtFindbugsTF>

Parameters:

o - The source. If this is a Collection or an array, it is flattened (see FlatteningList), and all objects in the collection or array are set.

Returns:

this

setSources

public ExtFindbugsTF setSources(Object o)

Description copied from interface: SourceConfigurable

This method does the same as SourceConfigurable.setSource(Object)

Specified by:

setSources in interface SourceConfigurable<ExtFindbugsTF>

Parameters:

o - The source or sources.

Returns:

this

addSource

public ExtFindbugsTF addSource(Object o)

Description copied from interface: SourceConfigurable

Add one or several sources.

Specified by:

addSource in interface SourceConfigurable<ExtFindbugsTF>

Parameters:

o - The source. If this is a Collection or an array, it is flattened (see FlatteningList), and all sources in the collection or array are added.

Returns:

this

addSources

public ExtFindbugsTF addSources(Object o)

Description copied from interface: SourceConfigurable

This method does the same as SourceConfigurable.addSource(Object)

Specified by:

addSources in interface SourceConfigurable<ExtFindbugsTF>

Parameters:

o - The source or sources.

Returns:

this

clearSources

public ExtFindbugsTF clearSources()

Description copied from interface: SourceConfigurable

Clear the collection of sources.

Specified by:

clearSources in interface SourceConfigurable<ExtFindbugsTF>

Returns:

this.

setRelativeToBase

public ExtFindbugsTF setRelativeToBase(RelativeLocation rel)

Description copied from interface: SourceConfigurable

This property is set with the task's source's location relative to a base location if the task is run within a recursive task. The base location is the location of the source of the recursive task.

If the SourceConfigurable (this object) is an action task factory that is used in a recursive action task, the recursive action task sets this property for each created task.

Specified by:

setRelativeToBase in interface SourceConfigurable<ExtFindbugsTF>

Parameters:

rel - The source's location relative to the base location.

Returns:

this

createSpecification

protected ExtFindbugsTask createSpecification()

Description copied from class: AbstractTaskFactory

Subclasses implement this to create the task specification object that this factory uses to configure the task that it is creating.

Specified by:

createSpecification in class AbstractTaskFactory<ExtFindbugsTF,ExtFindbugsTask>