Package rife.bld.extension

Class SpotBugsOperation

java.lang.Object

rife.bld.operations.AbstractOperation<T>

rife.bld.operations.AbstractProcessOperation<SpotBugsOperation>

rife.bld.extension.SpotBugsOperation

public class SpotBugsOperation
extends AbstractProcessOperation<SpotBugsOperation>

Run SpotBugs with the specified arguments.

Since:

1.0

Author:

Erik C. Thauvin

Field Summary

Fields inherited from class rife.bld.operations.AbstractProcessOperation

classpath_, DEFAULT_JAVA_TOOL, environment_, errorProcessor_, errorProcessorThread_, javaOptions_, javaTool_, mainClass_, module_, modulePath_, outputProcessor_, outputProcessorThread_, process_, successful_

Constructor Summary

Constructors

Constructor	Description
SpotBugsOperation()

Method Summary

Modifier and Type	Method	Description
boolean	adjustExperimental()	Returns whether experimental bug patterns will have their priority lowered.
SpotBugsOperation	adjustExperimental(boolean adjustExperimental)	Lower priority of experimental Bug Patterns.
List<String>	adjustPriorities()	Returns the collection of adjusted priorities.
SpotBugsOperation	adjustPriority(String name, int priority)	Adjust the priority of warnings for a given detector (simple or fully qualified class name) or bug pattern, or suppress it completely.
SpotBugsOperation	adjustPriority(String name, Priority priority)	Adjust the priority of warnings for a given detector (simple or fully qualified class name) or bug pattern, or suppress it completely.
List<File>	analyze()	Returns the collection of files configured to be analyzed.
SpotBugsOperation	analyze(File... files)	Specifies files to analyze for bugs.
SpotBugsOperation	analyze(String... files)	Specifies files to analyze for bugs.
SpotBugsOperation	analyze(Path... files)	Specifies files to analyze for bugs.
final SpotBugsOperation	analyze(Collection<File>... files)	Specifies files to analyze for bugs.
final SpotBugsOperation	analyzePaths(Collection<Path>... files)	Specifies files to analyze for bugs.
final SpotBugsOperation	analyzeStrings(Collection<String>... files)	Specifies files to analyze for bugs.
boolean	applySuppression()	Returns whether suppression from filter files is applied.
SpotBugsOperation	applySuppression(boolean applySuppression)	Exclude any bugs that match suppression filter loaded from fbp file.
List<String>	auxClasspath()	Returns the auxiliary classpath used for analysis.
SpotBugsOperation	auxClasspath(String... paths)	Set the auxiliary classpath for analysis.
final SpotBugsOperation	auxClasspath(Collection<String>... paths)	Set the auxiliary classpath for analysis.
List<String>	bugCategories()	Returns the configured bug categories to report.
SpotBugsOperation	bugCategories(String... categories)	Only report bugs in given categories.
final SpotBugsOperation	bugCategories(Collection<String>... categories)	Only report bugs in given categories.
List<String>	bugReporters()	Returns the collection of bug reporter decorators that are enabled/disabled.
SpotBugsOperation	bugReporters(String... reporters)	Bug reporter decorators to explicitly enable/disable.
final SpotBugsOperation	bugReporters(Collection<String>... reporters)	Bug reporter decorators to explicitly enable/disable.
List<String>	choosePlugins()	Returns the collection of chosen plugin enable/disable decorators.
SpotBugsOperation	choosePlugins(String... plugins)	Selectively enable/disable plugins.
final SpotBugsOperation	choosePlugins(Collection<String>... plugins)	Selectively enable/disable plugins.
List<String>	chooseVisitors()	Returns the collection of chosen visitor enable/disable decorators.
SpotBugsOperation	chooseVisitors(String... visitors)	Selectively enable/disable detectors.
final SpotBugsOperation	chooseVisitors(Collection<String>... visitors)	Selectively enable/disable detectors.
boolean	debug()	Retrieves the debug state.
SpotBugsOperation	debug(boolean debug)	Sets the debug mode for the SpotBugs operation.
boolean	detailedMessage()	Returns whether detailed messages are enabled.
SpotBugsOperation	detailedMessage(boolean detailedMessage)	Sets whether detailed messages should be printed.
boolean	dontCombineWarnings()	Returns whether warnings that differ only by line number are combined.
SpotBugsOperation	dontCombineWarnings(boolean dontCombineWarnings)	Don't combine warnings that differ only in line number.
Effort	effort()	Returns the configured analysis effort level.
SpotBugsOperation	effort(Effort effort)	Set the analysis effort level.
File	emacs()	Returns the Emacs bug reports file.
SpotBugsOperation	emacs(File file)	Produce the bug reports in Emacs format.
SpotBugsOperation	emacs(String file)	Produce the bug reports in Emacs format.
SpotBugsOperation	emacs(Path file)	Produce the bug reports in Emacs format.
File	exclude()	Returns the configured filter file used to exclude bugs.
SpotBugsOperation	exclude(File excludeFilter)	Report all bug instances except those matching the filter specified by the filter file.
SpotBugsOperation	exclude(String excludeFilter)	Report all bug instances except those matching the filter specified by the filter file.
SpotBugsOperation	exclude(Path excludeFilter)	Report all bug instances except those matching the filter specified by the filter file.
File	excludeBugs()	Returns the exclude file used to exclude bugs.
SpotBugsOperation	excludeBugs(File excludeFile)	Exclude bugs that are also reported in the baseline XML output.
SpotBugsOperation	excludeBugs(String excludeFile)	Exclude bugs that are also reported in the baseline XML output.
SpotBugsOperation	excludeBugs(Path excludeFile)	Exclude bugs that are also reported in the baseline XML output.
void	execute()	Performs the operation.
protected List<String>	executeConstructProcessCommandList()	Part of the execute operation constructs the command list to use for building the process.
boolean	experimental()	Returns whether experimental bug patterns are included in the report.
SpotBugsOperation	experimental(boolean experimental)	Report of any confidence level including experimental bug patterns.
SpotBugsOperation	fromProject(BaseProject project)	Configures the operation from a BaseProject.
SpotBugsOperation	fromProject(BaseProject project, boolean includeTest)	Configures a compile operation from a BaseProject.
boolean	high()	Returns whether only high-priority bugs will be reported.
SpotBugsOperation	high(boolean high)	Report only high-priority bugs.
Path	home()	Returns the SpotBugs home directory.
SpotBugsOperation	home(File home)	Specify SpotBugs home directory.
SpotBugsOperation	home(String home)	Specify SpotBugs home directory.
SpotBugsOperation	home(Path home)	Specify SpotBugs home directory.
File	html()	Returns the HTML output file.
SpotBugsOperation	html(File file)	Generate HTML output.
SpotBugsOperation	html(File file, String stylesheet)	Generate HTML output.
SpotBugsOperation	html(String file)	Generate HTML output.
SpotBugsOperation	html(String file, String stylesheet)	Generate HTML output.
SpotBugsOperation	html(Path filePath)	Generate HTML output.
SpotBugsOperation	html(Path filePath, String stylesheet)	Generate HTML output.
boolean	ignoreFailures()	Return the ignore failures flag.
SpotBugsOperation	ignoreFailures(boolean ignoreFailures)	Sets the flag to indicate whether failures should be ignored.
File	include()	Returns the include filter file.
SpotBugsOperation	include(File includeFilter)	Only report bug instances that match the filter specified by filter file.
SpotBugsOperation	include(String includeFilter)	Only report bug instances that match the filter specified by filter file.
SpotBugsOperation	include(Path includeFilter)	Only report bug instances that match the filter specified by filter file.
boolean	includeLineNumber()	Returns whether the line number should be included in source file URIs.
SpotBugsOperation	includeLineNumber(boolean includeLineNumber)	Enable or disable line number in source file URIs.
List<String>	jvmArgs()	Returns the collection of JVM arguments configured for the SpotBugs run.
SpotBugsOperation	jvmArgs(String... args)	Specifies arguments to pass to the JVM.
final SpotBugsOperation	jvmArgs(Collection<String>... args)	Specifies arguments to pass to the JVM.
boolean	longBugCodes()	Returns whether long bug codes are enabled.
SpotBugsOperation	longBugCodes(boolean longBugCodes)	Report long bug codes.
boolean	low()	Returns whether all bugs are reported.
SpotBugsOperation	low(boolean low)	Report all bugs.
int	maxHeap()	Returns the configured maximum Java heap size in megabytes.
SpotBugsOperation	maxHeap(int size)	Specifies the maximum Java heap size in megabytes.
int	maxRank()	Returns the configured maximum bug rank threshold.
SpotBugsOperation	maxRank(int maxRank)	Only report issues with a bug rank at least as scary as that provided.
boolean	medium()	Returns whether medium-priority bugs are reported.
SpotBugsOperation	medium(boolean medium)	Report medium and high-priority bugs.
boolean	nested()	Returns whether nested jar/zip scanning is enabled.
SpotBugsOperation	nested(boolean nested)	This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.
boolean	noClassOk()	Returns whether an empty warning file is allowed when no classes are specified.
SpotBugsOperation	noClassOk(boolean noClassOk)	Output an empty warning file if no classes are specified.
List<String>	omitVisitors()	Returns the collection of visitors configured to be omitted.
SpotBugsOperation	omitVisitors(String... visitors)	Omit named visitors.
final SpotBugsOperation	omitVisitors(Collection<String>... visitors)	Omit named visitors.
List<String>	onlyAnalyze()	Returns the collection of analyze-only patterns configured.
SpotBugsOperation	onlyAnalyze(String... patterns)	Restrict analysis to find bugs to ist of classes and packages.
final SpotBugsOperation	onlyAnalyze(Collection<String>... patterns)	Restrict analysis to find bugs to ist of classes and packages.
File	output()	Returns the configured XML bug report output file.
SpotBugsOperation	output(File file)	Sets the XML bug report file path.
SpotBugsOperation	output(String file)	Sets the XML bug report file path.
SpotBugsOperation	output(Path filePath)	Sets the XML bug report file path.
static int	parseIntOrDefault(String s)	Parses the given string into an integer.
static int	parseIntOrDefault(String s, int defaultValue)	Parses the given string into an integer.
List<String>	pluginList()	Returns the collection of plugin jar files to load.
SpotBugsOperation	pluginList(String... plugins)	Specify a list of plugin Jar files to load.
final SpotBugsOperation	pluginList(Collection<String>... plugins)	Specify a list of plugin Jar files to load.
boolean	progress()	Retrieves the current progress setting.
SpotBugsOperation	progress(boolean progress)	Display progress in the terminal window.
String	projectName()	Returns the configured descriptive project name.
SpotBugsOperation	projectName(String name)	Descriptive name of the project.
boolean	relaxed()	Returns whether relaxed reporting mode is enabled.
SpotBugsOperation	relaxed(boolean relaxed)	Relaxed reporting mode.
String	release()	Returns the configured release name for the analyzed application.
SpotBugsOperation	release(String release)	Set the release name of the analyzed application.
File	sarif()	Returns the SARIF bug reports file.
SpotBugsOperation	sarif(File file)	Produce the bug reports in SARIF 2.1.0.
SpotBugsOperation	sarif(String file)	Produce the bug reports in SARIF 2.1.0.
SpotBugsOperation	sarif(Path filePath)	Produce the bug reports in SARIF 2.1.0.
boolean	sortByClass()	Returns whether bug instances will be sorted by class name.
SpotBugsOperation	sortByClass(boolean sortByClass)	Sort reported bug instances by class name.
File	sourceInfo()	Returns the source info file containing line numbers for fields/classes.
SpotBugsOperation	sourceInfo(File sourceInfo)	Specify the source info file (line numbers for fields/classes).
SpotBugsOperation	sourceInfo(String sourceInfo)	Specify the source info file (line numbers for fields/classes).
SpotBugsOperation	sourceInfo(Path sourceInfo)	Specify the source info file (line numbers for fields/classes).
List<String>	sourcePath()	Returns the source path for analyzed classes.
SpotBugsOperation	sourcePath(File... path)	Set the source path for analyzed classes.
SpotBugsOperation	sourcePath(String... path)	Set the source path for analyzed classes.
SpotBugsOperation	sourcePath(Path... path)	Set the source path for analyzed classes.
final SpotBugsOperation	sourcePath(Collection<String>... path)	Set the source path for analyzed classes.
final SpotBugsOperation	sourcePathFiles(Collection<File>... path)	Set the source path for analyzed classes.
final SpotBugsOperation	sourcePathPaths(Collection<Path>... path)	Set the source path for analyzed classes.
File	spotBugsJar()	Returns the SpotBugs jar file.
SpotBugsOperation	spotBugsJar(File jar)	Sets the SpotBugs jar file.
SpotBugsOperation	spotBugsJar(String jar)	Sets the SpotBugs jar file.
SpotBugsOperation	spotBugsJar(Path jarPath)	Sets the SpotBugs jar file.
boolean	timestampNow()	Returns whether the timestamp of results will be set to the current time.
SpotBugsOperation	timestampNow(boolean timeStampNow)	Set the timestamp of results to be the current time.
List<String>	visitors()	Returns the collection of named visitors to run.
SpotBugsOperation	visitors(String... visitors)	Run only named visitors.
final SpotBugsOperation	visitors(Collection<String>... visitors)	Run only named visitors.
boolean	workHard()	Returns whether analysis effort should be at least Effort.DEFAULT.
SpotBugsOperation	workHard(boolean workHard)	Ensure analysis effort is at least Effort.DEFAULT.

Methods inherited from class rife.bld.operations.AbstractProcessOperation

classpath, classpath, classpath, classpath, classpath, environment, environment, environment, errorProcessor, errorProcessor, executeStartProcess, javaOptions, javaOptions, javaTool, javaTool, mainClass, mainClass, module, module, modulePath, modulePath, modulePath, modulePath, modulePath, outputProcessor, outputProcessor, process, workDirectory, workDirectory

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent

Methods inherited from class java.lang.Object

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

Constructor Details

SpotBugsOperation

public SpotBugsOperation()

Method Details

execute

public void execute()
             throws IOException,
FileUtilsErrorException,
InterruptedException,
ExitStatusException

Performs the operation.

Overrides:

execute in class AbstractProcessOperation<SpotBugsOperation>

Throws:

InterruptedException - when the operation was interrupted

IOException - when an exception occurred during the execution of the process

FileUtilsErrorException - when an exception occurred during the retrieval of the operation output

ExitStatusException - when the exit status was changed during the operation

executeConstructProcessCommandList

protected List<String> executeConstructProcessCommandList()

Part of the execute operation constructs the command list to use for building the process.

Specified by:

executeConstructProcessCommandList in class AbstractProcessOperation<SpotBugsOperation>

Returns:

a list of strings representing the commands or an empty list if no commands are constructed.

fromProject

public SpotBugsOperation fromProject(BaseProject project)

Configures the operation from a BaseProject.

Sets the following from the project:

• analyze to buildMainDirectory
• auxClasspath to compileMainClasspath
• nested and timestampNow to true
• output to reports/spotbugs/spotbugs.xml in the buildDirectory
• projectName to the project name
• sarif to reports/spotbugs/spotbugs.sarif in the buildDirectory
• sourcePath to srcMainJavaDirectory and srcMainResourceDirectory

Specified by:

fromProject in class AbstractProcessOperation<SpotBugsOperation>

Parameters:

project - the project to configure the compile operation from

Returns:

this operation instance

See Also:

• fromProject(BaseProject, boolean)

parseIntOrDefault

public static int parseIntOrDefault(String s)

Parses the given string into an integer.

If the string cannot be parsed, returns a default value of -1.

Parameters:

s - the string to be parsed into an integer

Returns:

the parsed integer value, or -1 if parsing fails

See Also:

• parseIntOrDefault(String, int)

parseIntOrDefault

public static int parseIntOrDefault(String s,
 int defaultValue)

Parses the given string into an integer.

If the string is null, empty, or cannot be parsed as an integer, it returns the specified default value.

Parameters:

s - the string to parse as an integer

defaultValue - the value to return if parsing fails

Returns:

the parsed integer value, or the default value if parsing fails

See Also:

• parseIntOrDefault(String)

adjustExperimental

public SpotBugsOperation adjustExperimental(boolean adjustExperimental)

Lower priority of experimental Bug Patterns.

Parameters:

adjustExperimental - set to true to lower priority, false otherwise

Returns:

this operation

See Also:

• adjustExperimental()

adjustExperimental

public boolean adjustExperimental()

Returns whether experimental bug patterns will have their priority lowered.

Returns:

true if experimental patterns priorities are adjusted, false otherwise

See Also:

• adjustExperimental(boolean)

adjustPriorities

public List<String> adjustPriorities()

Returns the collection of adjusted priorities.

Each element is formatted as: name=value

Returns:

a collection containing the adjusted priorities as strings

See Also:

• adjustPriority(String, int)
• adjustPriority(String, Priority)

adjustPriority

public SpotBugsOperation adjustPriority(String name,
 int priority)

Adjust the priority of warnings for a given detector (simple or fully qualified class name) or bug pattern, or suppress it completely.

An unsigned integer sets the priority to an absolute value.

Note that -1 is equivalent Priority.RAISE, and semantically increases the priority.

Parameters:

name - the detector or bug pattern name

priority - the priority level to adjust

See Also:

• adjustPriority(String, Priority)
• adjustPriorities()

adjustPriority

public SpotBugsOperation adjustPriority(String name,
 Priority priority)

Adjust the priority of warnings for a given detector (simple or fully qualified class name) or bug pattern, or suppress it completely.

Parameters:

name - the detector or bug pattern name

priority - the priority level to adjust

Returns:

this operation

See Also:

• adjustPriority(String, int)
• adjustPriorities()

analyze

public SpotBugsOperation analyze(String... files)

Specifies files to analyze for bugs.

Parameters:

files - array of file paths to analyze

Returns:

this operation

See Also:

• analyze(File...)
• analyze(Path...)
• analyze(Collection...)
• analyzeStrings(Collection...)

analyze

public SpotBugsOperation analyze(File... files)

Specifies files to analyze for bugs.

Parameters:

files - array of files to analyze

Returns:

this operation

See Also:

• analyze(String...)
• analyze(Path...)
• analyze(Collection...)

analyze

public SpotBugsOperation analyze(Path... files)

Specifies files to analyze for bugs.

Parameters:

files - array of files to analyze

Returns:

this operation

See Also:

• analyze(String...)
• analyze(File...)
• analyze(Collection...)
• analyzePaths(Collection...)

analyze

public List<File> analyze()

Returns the collection of files configured to be analyzed.

Returns:

a collection containing the files to analyze

See Also:

• analyze(String...)
• analyze(File...)
• analyze(Path...)
• analyze(Collection...)

analyze

@SafeVarargs
public final SpotBugsOperation analyze(Collection<File>... files)

Specifies files to analyze for bugs.

Parameters:

files - collection of files to analyze

Returns:

this operation

See Also:

• analyze(String...)
• analyze(File...)
• analyze(Path...)

analyzePaths

@SafeVarargs
public final SpotBugsOperation analyzePaths(Collection<Path>... files)

Specifies files to analyze for bugs.

Parameters:

files - collection of files to analyze

Returns:

this operation

See Also:

• analyze(Path...)
• analyze(Collection...)

analyzeStrings

@SafeVarargs
public final SpotBugsOperation analyzeStrings(Collection<String>... files)

Specifies files to analyze for bugs.

Parameters:

files - collection of files to analyze

Returns:

this operation

See Also:

• analyze(String...)
• analyze(Collection...)

applySuppression

public SpotBugsOperation applySuppression(boolean applySuppression)

Exclude any bugs that match suppression filter loaded from fbp file.

Parameters:

applySuppression - set to true to enable, false otherwise

Returns:

this operation

See Also:

• applySuppression()

applySuppression

public boolean applySuppression()

Returns whether suppression from filter files is applied.

Returns:

true if suppression is applied, false otherwise

See Also:

• applySuppression(boolean)

auxClasspath

public SpotBugsOperation auxClasspath(String... paths)

Set the auxiliary classpath for analysis.

This classpath should include all jar files and directories containing classes that are part of the program being analyzed, but you do not want to have analyzed for bugs.

Parameters:

paths - the auxiliary paths to set

Returns:

this operation

See Also:

• auxClasspath(Collection...)
• auxClasspath()

auxClasspath

@SafeVarargs
public final SpotBugsOperation auxClasspath(Collection<String>... paths)

Set the auxiliary classpath for analysis.

This classpath should include all jar files and directories containing classes that are part of the program being analyzed, but you do not want to have analyzed for bugs.

Parameters:

paths - the auxiliary paths to set

Returns:

this operation

See Also:

• auxClasspath(String...)
• auxClasspath()

auxClasspath

public List<String> auxClasspath()

Returns the auxiliary classpath used for analysis.

Returns:

a collection containing the auxiliary classpath entries

See Also:

• auxClasspath(String...)
• auxClasspath(Collection...)

bugCategories

public SpotBugsOperation bugCategories(String... categories)

Only report bugs in given categories.

Parameters:

categories - the bug categories

Returns:

this operation

See Also:

• bugCategories(Collection...)
• bugCategories()

bugCategories

@SafeVarargs
public final SpotBugsOperation bugCategories(Collection<String>... categories)

Only report bugs in given categories.

Parameters:

categories - the bug categories

Returns:

this operation

See Also:

• bugCategories(String...)
• bugCategories()

bugCategories

public List<String> bugCategories()

Returns the configured bug categories to report.

Returns:

a collection containing the bug categories

See Also:

• bugCategories(String...)
• bugCategories(Collection...)

bugReporters

public SpotBugsOperation bugReporters(String... reporters)

Bug reporter decorators to explicitly enable/disable.

Prefix the reporter name with - to disable.

Parameters:

reporters - the reporters to enable/disable

Returns:

this operation

See Also:

• bugReporters(Collection...)
• bugReporters()

bugReporters

@SafeVarargs
public final SpotBugsOperation bugReporters(Collection<String>... reporters)

Bug reporter decorators to explicitly enable/disable.

Prefix the reporter name with - to disable.

Parameters:

reporters - the reporters to enable/disable

Returns:

this operation

See Also:

• bugReporters(String...)
• bugReporters()

bugReporters

public List<String> bugReporters()

Returns the collection of bug reporter decorators that are enabled/disabled.

Returns:

a collection containing the bug reporters

See Also:

• bugReporters(String...)
• bugReporters(Collection...)

choosePlugins

public SpotBugsOperation choosePlugins(String... plugins)

Selectively enable/disable plugins.

Prefix the plugin name with - to disable.

Parameters:

plugins - the plugins to enable/disable

Returns:

this operation

See Also:

• choosePlugins(Collection...)
• choosePlugins()

choosePlugins

@SafeVarargs
public final SpotBugsOperation choosePlugins(Collection<String>... plugins)

Selectively enable/disable plugins.

Prefix the plugin name with - to disable.

Parameters:

plugins - the plugins to enable/disable

Returns:

this operation

See Also:

• choosePlugins(String...)
• choosePlugins()

choosePlugins

public List<String> choosePlugins()

Returns the collection of chosen plugin enable/disable decorators.

Returns:

a collection containing the chosen plugin strings

See Also:

• choosePlugins(String...)
• choosePlugins(Collection...)

chooseVisitors

public SpotBugsOperation chooseVisitors(String... visitors)

Selectively enable/disable detectors.

Prefix the detector name with - to disable.

Parameters:

visitors - the visitors to enable/disable

Returns:

this operation

See Also:

• chooseVisitors(Collection...)
• chooseVisitors()

chooseVisitors

@SafeVarargs
public final SpotBugsOperation chooseVisitors(Collection<String>... visitors)

Selectively enable/disable detectors.

Prefix the detector name with - to disable.

Parameters:

visitors - the visitors to enable/disable

Returns:

this operation

See Also:

• chooseVisitors(String...)
• chooseVisitors()

chooseVisitors

public List<String> chooseVisitors()

Returns the collection of chosen visitor enable/disable decorators.

Returns:

a collection containing the chosen visitor strings

See Also:

• chooseVisitors(String...)
• chooseVisitors(Collection...)

debug

public SpotBugsOperation debug(boolean debug)

Sets the debug mode for the SpotBugs operation.

Parameters:

debug - true to enable, false otherwise

Returns:

this operation

See Also:

• debug()

debug

public boolean debug()

Retrieves the debug state.

Returns:

true if debug mode is enabled, false otherwise.

See Also:

• debug(boolean)

detailedMessage

public SpotBugsOperation detailedMessage(boolean detailedMessage)

Sets whether detailed messages should be printed.

Parameters:

detailedMessage - true to enable, false otherwise

Returns:

this operation

See Also:

• detailedMessage()

detailedMessage

public boolean detailedMessage()

Returns whether detailed messages are enabled.

Returns:

true if detailed messages will be printed, false otherwise

See Also:

• detailedMessage(boolean)

dontCombineWarnings

public SpotBugsOperation dontCombineWarnings(boolean dontCombineWarnings)

Don't combine warnings that differ only in line number.

Parameters:

dontCombineWarnings - set to true to enable, false otherwise

Returns:

this operation

See Also:

• dontCombineWarnings()

dontCombineWarnings

public boolean dontCombineWarnings()

Returns whether warnings that differ only by line number are combined.

Returns:

true if warnings are not combined, false otherwise

See Also:

• dontCombineWarnings(boolean)

effort

public SpotBugsOperation effort(Effort effort)

Set the analysis effort level.

The Effort.MIN disables several analyses that increase precision but also increase memory consumption. You may want to try this option if you find that SpotBugs with the Effort.LESS still runs out of memory, or takes an unusually long time to complete its analysis.

The Effort.LESS disables some analyses that increase precision but also increase memory consumption. You may want to try this option if you find that SpotBugs with the Effort.MORE/Effort.DEFAULT runs out of memory, or takes an unusually long time to complete its analysis.

The Effort.MORE runs several analyses to find bugs, this is the Effort.DEFAULT.

The Effort.MAX enable analyses which increase precision and find more bugs, but which may require more memory and take more time to complete.

Parameters:

effort - the effort level

Returns:

this operation

See Also:

• Effort
• effort()

effort

public Effort effort()

Returns the configured analysis effort level.

Returns:

the Effort configured for this operation, or null if none

See Also:

• effort(Effort)

emacs

public SpotBugsOperation emacs(File file)

Produce the bug reports in Emacs format.

Parameters:

file - the output file

Returns:

this operation

See Also:

• emacs(String)
• emacs(Path)
• emacs()

emacs

public SpotBugsOperation emacs(Path file)

Produce the bug reports in Emacs format.

Parameters:

file - the output file

Returns:

this operation

See Also:

• emacs(String)
• emacs(File)
• emacs()

emacs

public SpotBugsOperation emacs(String file)

Produce the bug reports in Emacs format.

Parameters:

file - the output file

Returns:

this operation

See Also:

• emacs(File)
• emacs(Path)
• emacs()

emacs

public File emacs()

Returns the Emacs bug reports file.

Returns:

the bug reports file

See Also:

• emacs(File)
• emacs(String)
• emacs(Path)

exclude

public SpotBugsOperation exclude(File excludeFilter)

Report all bug instances except those matching the filter specified by the filter file.

Parameters:

excludeFilter - the filter file

Returns:

this operation

See Also:

• exclude(String)
• exclude(Path)
• exclude()

exclude

public SpotBugsOperation exclude(String excludeFilter)

Report all bug instances except those matching the filter specified by the filter file.

Parameters:

excludeFilter - the filter file

Returns:

this operation

See Also:

• exclude(File)
• exclude(Path)
• exclude()

exclude

public SpotBugsOperation exclude(Path excludeFilter)

Report all bug instances except those matching the filter specified by the filter file.

Parameters:

excludeFilter - the filter file

Returns:

this operation

See Also:

• exclude(File)
• exclude(String)
• exclude()

exclude

public File exclude()

Returns the configured filter file used to exclude bugs.

Returns:

the exclude filter File, or null if none configured

See Also:

• exclude(File)
• exclude(String)
• exclude(Path)

excludeBugs

public SpotBugsOperation excludeBugs(String excludeFile)

Exclude bugs that are also reported in the baseline XML output.

Parameters:

excludeFile - the exclude file

Returns:

this operation

See Also:

• excludeBugs(File)
• excludeBugs(Path)
• excludeBugs()

excludeBugs

public SpotBugsOperation excludeBugs(File excludeFile)

Exclude bugs that are also reported in the baseline XML output.

Parameters:

excludeFile - the exclude file

Returns:

this operation

See Also:

• excludeBugs(String)
• excludeBugs(Path)
• excludeBugs()

excludeBugs

public SpotBugsOperation excludeBugs(Path excludeFile)

Exclude bugs that are also reported in the baseline XML output.

Parameters:

excludeFile - the exclude file

Returns:

this operation

See Also:

• excludeBugs(File)
• excludeBugs(String)
• excludeBugs()

excludeBugs

public File excludeBugs()

Returns the exclude file used to exclude bugs.

Returns:

the exclude file

See Also:

• excludeBugs(String)
• excludeBugs(File)
• excludeBugs(Path)

experimental

public SpotBugsOperation experimental(boolean experimental)

Report of any confidence level including experimental bug patterns.

Parameters:

experimental - set to true to enable, false otherwise

Returns:

this operation

See Also:

• experimental()

experimental

public boolean experimental()

Returns whether experimental bug patterns are included in the report.

Returns:

true if experimental patterns are reported, false otherwise

See Also:

• experimental(boolean)

fromProject

public SpotBugsOperation fromProject(BaseProject project,
 boolean includeTest)

Configures a compile operation from a BaseProject.

Sets the following from the project:

• analyze to buildMainDirectory
• auxClasspath to compileMainClasspath
• nested and timestampNow to true
• output to reports/spotbugs/spotbugs.xml in the buildDirectory
• projectName to the project name
• sarif to reports/spotbugs/spotbugs.sarif in the buildDirectory
• sourcePath to srcMainJavaDirectory and srcMainResourceDirectory

If includeTest is enabled, the test directories are also included.

Parameters:

project - the project to configure the compile operation from

includeTest - set to true to include test directories, false otherwise

Returns:

this operation instance

See Also:

• fromProject(BaseProject)

high

public SpotBugsOperation high(boolean high)

Report only high-priority bugs.

Parameters:

high - set to true to enable, false otherwise

Returns:

this operation

See Also:

• high()

high

public boolean high()

Returns whether only high-priority bugs will be reported.

Returns:

true if only high-priority bugs are reported, false otherwise

See Also:

• high(boolean)

home

public SpotBugsOperation home(String home)

Specify SpotBugs home directory.

Parameters:

home - the home directory

Returns:

this operation

See Also:

• home(File)
• home(Path)
• home()

home

public SpotBugsOperation home(File home)

Specify SpotBugs home directory.

Parameters:

home - the home directory

Returns:

this operation

See Also:

• home(String)
• home(Path)
• home()

home

public SpotBugsOperation home(Path home)

Specify SpotBugs home directory.

Parameters:

home - the home directory

Returns:

this operation

See Also:

• home(String)
• home(File)
• home()

home

public Path home()

Returns the SpotBugs home directory.

Returns:

the SpotBugs home path, or null if not set

See Also:

• home(String)
• home(File)
• home(Path)

html

public SpotBugsOperation html(File file)

Generate HTML output.

Parameters:

file - the output file

Returns:

this operation

See Also:

• html(String)
• html(Path)
• html(String, String)
• html(File, String)
• html(Path, String)
• html()

html

public SpotBugsOperation html(Path filePath)

Generate HTML output.

Parameters:

filePath - the output file

Returns:

this operation

See Also:

• html(String)
• html(File)
• html(String, String)
• html(File, String)
• html(Path, String)
• html()

html

public SpotBugsOperation html(String file)

Generate HTML output.

Parameters:

file - the output file

Returns:

this operation

See Also:

• html(File)
• html(Path)
• html(String, String)
• html(File, String)
• html(Path, String)
• html()

html

public File html()

Returns the HTML output file.

Returns:

the HTML output file

See Also:

• html(File)
• html(String)
• html(Path)
• html(String, String)
• html(File, String)
• html(Path, String)

html

public SpotBugsOperation html(String file,
 String stylesheet)

Generate HTML output.

By default, SpotBugs will use the default.xsl XSLT stylesheet to generate the HTML: you can find this file in spotbugs.jar, or in the SpotBugs source or binary distributions. Variants of this option include:

• plain.xsl
• fancy.xsl
• fancy-hist.xsl

The plain.xsl stylesheet does not use JavaScript or DOM, and may work better with older web browsers, or for printing.

The fancy.xsl stylesheet uses DOM and JavaScript for navigation and CSS for visual presentation.

The fancy-hist.xsl an evolution of fancy.xsl stylesheet. It makes extensive use of DOM and JavaScript for dynamically filtering the lists of bugs.

If you want to specify your own XSLT stylesheet to perform the transformation to HTML, specify the option as myStylesheet.xsl, the filename of the stylesheet you want to use.

Parameters:

file - the output file

stylesheet - the stylesheet to use

Returns:

this operation

See Also:

• html(String)
• html(Path)
• html(File)
• html(File, String)
• html(Path, String)
• html()

html

public SpotBugsOperation html(Path filePath,
 String stylesheet)

Generate HTML output.

By default, SpotBugs will use the default.xsl XSLT stylesheet to generate the HTML: you can find this file in spotbugs.jar, or in the SpotBugs source or binary distributions. Variants of this option include:

• plain.xsl
• fancy.xsl
• fancy-hist.xsl

The plain.xsl stylesheet does not use JavaScript or DOM, and may work better with older web browsers, or for printing.

The fancy.xsl stylesheet uses DOM and JavaScript for navigation and CSS for visual presentation.

The fancy-hist.xsl an evolution of fancy.xsl stylesheet. It makes extensive use of DOM and JavaScript for dynamically filtering the lists of bugs.

If you want to specify your own XSLT stylesheet to perform the transformation to HTML, specify the option as myStylesheet.xsl, the filename of the stylesheet you want to use.

Parameters:

filePath - the output file

stylesheet - the stylesheet to use

Returns:

this operation

See Also:

• html(String)
• html(File)
• html(Path)
• html(File, String)
• html(String, String)
• html()

html

public SpotBugsOperation html(File file,
 String stylesheet)

Generate HTML output.

By default, SpotBugs will use the default.xsl XSLT stylesheet to generate the HTML: you can find this file in spotbugs.jar, or in the SpotBugs source or binary distributions. Variants of this option include:

• plain.xsl
• fancy.xsl
• fancy-hist.xsl

The plain.xsl stylesheet does not use JavaScript or DOM, and may work better with older web browsers, or for printing.

The fancy.xsl stylesheet uses DOM and JavaScript for navigation and CSS for visual presentation.

The fancy-hist.xsl an evolution of fancy.xsl stylesheet. It makes extensive use of DOM and JavaScript for dynamically filtering the lists of bugs.

If you want to specify your own XSLT stylesheet to perform the transformation to HTML, specify the option as myStylesheet.xsl, the filename of the stylesheet you want to use.

Parameters:

file - the output file

stylesheet - the stylesheet to use

Returns:

this operation

See Also:

• html(String)
• html(Path)
• html(File)
• html(String, String)
• html(Path, String)
• html()

ignoreFailures

public SpotBugsOperation ignoreFailures(boolean ignoreFailures)

Sets the flag to indicate whether failures should be ignored.

The default is enabled.

Parameters:

ignoreFailures - true to enable, false to disable.

Returns:

this operation

See Also:

• ignoreFailures()

ignoreFailures

public boolean ignoreFailures()

Return the ignore failures flag.

Returns:

true if enabled, false otherwise

See Also:

• ignoreFailures(boolean)

include

public SpotBugsOperation include(String includeFilter)

Only report bug instances that match the filter specified by filter file.

Parameters:

includeFilter - the filter file

Returns:

this operation

See Also:

• include(File)
• include(Path)
• include()

include

public SpotBugsOperation include(File includeFilter)

Only report bug instances that match the filter specified by filter file.

Parameters:

includeFilter - the filter file

Returns:

this operation

See Also:

• include(String)
• include(Path)
• include()

include

public SpotBugsOperation include(Path includeFilter)

Only report bug instances that match the filter specified by filter file.

Parameters:

includeFilter - the filter file

Returns:

this operation

See Also:

• include(File)
• include(String)
• include()

include

public File include()

Returns the include filter file.

Returns:

the include filter File, or null if none configured

See Also:

• include(String)
• include(File)
• include(Path)

includeLineNumber

public SpotBugsOperation includeLineNumber(boolean includeLineNumber)

Enable or disable line number in source file URIs.

While clicking on the URI works in IntelliJ IDEA, Visual Studio Code, etc.; it might not in terminal emulators.

< Enabled by default.

Parameters:

includeLineNumber - true to enable, false otherwise

Returns:

this operation

See Also:

• includeLineNumber()

includeLineNumber

public boolean includeLineNumber()

Returns whether the line number should be included in source file URIs.

Returns:

true if the line number should be included, false otherwise

See Also:

• includeLineNumber(boolean)

jvmArgs

public SpotBugsOperation jvmArgs(String... args)

Specifies arguments to pass to the JVM.

Parameters:

args - the args to pass to JVM

Returns:

this operation

See Also:

• jvmArgs(Collection...)
• jvmArgs()

jvmArgs

@SafeVarargs
public final SpotBugsOperation jvmArgs(Collection<String>... args)

Specifies arguments to pass to the JVM.

Parameters:

args - the args to pass to JVM

Returns:

this operation

See Also:

• jvmArgs(String...)
• jvmArgs()

jvmArgs

public List<String> jvmArgs()

Returns the collection of JVM arguments configured for the SpotBugs run.

Returns:

a collection containing JVM arguments

See Also:

• jvmArgs(String...)
• jvmArgs(Collection...)

longBugCodes

public SpotBugsOperation longBugCodes(boolean longBugCodes)

Report long bug codes.

Parameters:

longBugCodes - set to true to enable, false otherwise

Returns:

this operation

See Also:

• longBugCodes()

longBugCodes

public boolean longBugCodes()

Returns whether long bug codes are enabled.

Returns:

true if long bug codes will be reported, false otherwise

See Also:

• longBugCodes(boolean)

low

public SpotBugsOperation low(boolean low)

Report all bugs.

Parameters:

low - set to true to enable, false otherwise

Returns:

this operation

See Also:

• low()

low

public boolean low()

Returns whether all bugs are reported.

Returns:

true if all bugs are reported, false otherwise

See Also:

• low(boolean)

maxHeap

public SpotBugsOperation maxHeap(int size)

Specifies the maximum Java heap size in megabytes.

The default is 256. More memory may be required to analyze very large programs or libraries.

Parameters:

size - the maximum heap size in megabytes

Returns:

this operation

See Also:

• maxHeap()

maxHeap

public int maxHeap()

Returns the configured maximum Java heap size in megabytes.

Returns:

the maximum heap size in megabytes

See Also:

• maxHeap(int)

maxRank

public SpotBugsOperation maxRank(int maxRank)

Only report issues with a bug rank at least as scary as that provided.

Parameters:

maxRank - the maximum rank

Returns:

this operation

See Also:

• maxRank()

maxRank

public int maxRank()

Returns the configured maximum bug rank threshold.

Returns:

the maximum rank value

See Also:

• maxRank(int)

medium

public SpotBugsOperation medium(boolean medium)

Report medium and high-priority bugs.

This is the default setting.

Parameters:

medium - set to true to enable, false otherwise

Returns:

this operation

See Also:

• medium()

medium

public boolean medium()

Returns whether medium-priority bugs are reported.

Returns:

true if medium (and higher) priority bugs are reported, false otherwise

See Also:

• medium(boolean)

nested

public SpotBugsOperation nested(boolean nested)

This option enables or disables scanning of nested jar and zip files found in the list of files and directories to be analyzed.

By default, scanning of nested jar/zip files is enabled.

Parameters:

nested - set to true to enable, false otherwise

Returns:

this operation

See Also:

• nested()

nested

public boolean nested()

Returns whether nested jar/zip scanning is enabled.

Returns:

true if nested scanning is enabled, false otherwise

See Also:

• nested(boolean)

noClassOk

public SpotBugsOperation noClassOk(boolean noClassOk)

Output an empty warning file if no classes are specified.

Parameters:

noClassOk - set to true to enable, false otherwise

Returns:

this operation

See Also:

• noClassOk()

noClassOk

public boolean noClassOk()

Returns whether an empty warning file is allowed when no classes are specified.

Returns:

true if an empty warning file is allowed, false otherwise

See Also:

• noClassOk(boolean)

omitVisitors

public SpotBugsOperation omitVisitors(String... visitors)

Omit named visitors.

Parameters:

visitors - the visitors to omit

Returns:

this operation

See Also:

• omitVisitors(Collection...)
• omitVisitors()

omitVisitors

@SafeVarargs
public final SpotBugsOperation omitVisitors(Collection<String>... visitors)

Omit named visitors.

Parameters:

visitors - the visitors to omit

Returns:

this operation

See Also:

• omitVisitors(String...)
• omitVisitors()

omitVisitors

public List<String> omitVisitors()

Returns the collection of visitors configured to be omitted.

Returns:

a collection containing the visitors to omit

See Also:

• omitVisitors(String...)
• omitVisitors(Collection...)

onlyAnalyze

public SpotBugsOperation onlyAnalyze(String... patterns)

Restrict analysis to find bugs to ist of classes and packages.

Unlike filtering, this option avoids running analysis on classes and packages that are not explicitly matched: for large projects, this may greatly reduce the amount of time needed to run the analysis. (However, some detectors may produce inaccurate results if they aren't run on the entire application.)

Classes should be specified using their full classnames (including package).

Packages should be specified in the same way they would in a Java import statement to import all classes in the package (i.e., add .* to the full name of the package). Replace .* with .- to also analyze all subpackages.

Items starting with ! are treated as exclusions, removing otherwise-included classes from analysis.

Parameters:

patterns - the patterns to analyze

Returns:

this operation

See Also:

• onlyAnalyze(Collection...)
• onlyAnalyze()

onlyAnalyze

@SafeVarargs
public final SpotBugsOperation onlyAnalyze(Collection<String>... patterns)

Restrict analysis to find bugs to ist of classes and packages.

Unlike filtering, this option avoids running analysis on classes and packages that are not explicitly matched: for large projects, this may greatly reduce the amount of time needed to run the analysis. (However, some detectors may produce inaccurate results if they aren't run on the entire application.)

Classes should be specified using their full classnames (including package).

Packages should be specified in the same way they would in a Java import statement to import all classes in the package (i.e., add .* to the full name of the package). Replace .* with .- to also analyze all subpackages.

Items starting with ! are treated as exclusions, removing otherwise-included classes from analysis.

Parameters:

patterns - the patterns to analyze

Returns:

this operation

See Also:

• onlyAnalyze(String...)
• onlyAnalyze()

onlyAnalyze

public List<String> onlyAnalyze()

Returns the collection of analyze-only patterns configured.

Returns:

a collection of analyze-only patterns

See Also:

• onlyAnalyze(String...)
• onlyAnalyze(Collection...)

output

public SpotBugsOperation output(String file)

Sets the XML bug report file path.

The default is: spotbugs.xml

Parameters:

file - the file path

Returns:

this operation

See Also:

• output(File)
• output(Path)
• output()

output

public SpotBugsOperation output(File file)

Sets the XML bug report file path.

The default is: spotbugs.xml

Parameters:

file - the file path

Returns:

this operation

See Also:

• output(String)
• output(Path)
• output()

output

public SpotBugsOperation output(Path filePath)

Sets the XML bug report file path.

The default is: spotbugs.xml

Parameters:

filePath - the file path

Returns:

this operation

See Also:

• output(String)
• output(File)
• output()

output

public File output()

Returns the configured XML bug report output file.

Returns:

the output File

See Also:

• output(String)
• output(File)
• output(Path)

pluginList

public SpotBugsOperation pluginList(String... plugins)

Specify a list of plugin Jar files to load.

Parameters:

plugins - the plugin list

Returns:

this operation

See Also:

• pluginList(Collection...)
• pluginList()

pluginList

@SafeVarargs
public final SpotBugsOperation pluginList(Collection<String>... plugins)

Specify a list of plugin Jar files to load.

Parameters:

plugins - the plugin list

Returns:

this operation

See Also:

• pluginList(String...)
• pluginList()

pluginList

public List<String> pluginList()

Returns the collection of plugin jar files to load.

Returns:

a collection containing the plugin jar files

See Also:

• pluginList(String...)
• pluginList(Collection...)

progress

public SpotBugsOperation progress(boolean progress)

Display progress in the terminal window.

Parameters:

progress - set to true to enable, false otherwise

Returns:

this operation

See Also:

• progress()

progress

public boolean progress()

Retrieves the current progress setting.

Returns:

true if progress display is enabled, false otherwise

See Also:

• progress(boolean)

projectName

public SpotBugsOperation projectName(String name)

Descriptive name of the project.

Parameters:

name - the project name

Returns:

this operation

See Also:

• projectName()

projectName

public String projectName()

Returns the configured descriptive project name.

Returns:

the project name, or null if not configured

See Also:

• projectName(String)

relaxed

public SpotBugsOperation relaxed(boolean relaxed)

Relaxed reporting mode.

For many detectors, this option suppresses the heuristics used to avoid reporting false positives.

Parameters:

relaxed - set to true to enable, false otherwise

Returns:

this operation

See Also:

• relaxed()

relaxed

public boolean relaxed()

Returns whether relaxed reporting mode is enabled.

Returns:

true if relaxed mode is enabled, false otherwise

See Also:

• relaxed(boolean)

release

public SpotBugsOperation release(String release)

Set the release name of the analyzed application.

Parameters:

release - the release name

Returns:

this operation

See Also:

• release()

release

public String release()

Returns the configured release name for the analyzed application.

Returns:

the release name, or null if not set

See Also:

• release(String)

sarif

public SpotBugsOperation sarif(File file)

Produce the bug reports in SARIF 2.1.0.

Parameters:

file - the output file

Returns:

this operation

See Also:

• sarif(String)
• sarif(Path)
• sarif()

sarif

public SpotBugsOperation sarif(String file)

Produce the bug reports in SARIF 2.1.0.

Parameters:

file - the output file

Returns:

this operation

See Also:

• sarif(File)
• sarif(Path)
• sarif()

sarif

public SpotBugsOperation sarif(Path filePath)

Produce the bug reports in SARIF 2.1.0.

Parameters:

filePath - the output file

Returns:

this operation

See Also:

• sarif(String)
• sarif(File)
• sarif()

sarif

public File sarif()

Returns the SARIF bug reports file.

Returns:

the bug reports file

See Also:

• sarif(File)
• sarif(String)
• sarif(Path)

sortByClass

public boolean sortByClass()

Returns whether bug instances will be sorted by class name.

Returns:

true if enabled, false otherwise

See Also:

• sortByClass(boolean)

sortByClass

public SpotBugsOperation sortByClass(boolean sortByClass)

Sort reported bug instances by class name.

Parameters:

sortByClass - set to true to enable, false otherwise

Returns:

this operation

See Also:

• sortByClass()

sourceInfo

public SpotBugsOperation sourceInfo(String sourceInfo)

Specify the source info file (line numbers for fields/classes).

Parameters:

sourceInfo - the source info file

Returns:

this operation

See Also:

• sourceInfo(File)
• sourceInfo(Path)
• sourceInfo()

sourceInfo

public SpotBugsOperation sourceInfo(File sourceInfo)

Specify the source info file (line numbers for fields/classes).

Parameters:

sourceInfo - the source info file

Returns:

this operation

See Also:

• sourceInfo(String)
• sourceInfo(Path)
• sourceInfo()

sourceInfo

public SpotBugsOperation sourceInfo(Path sourceInfo)

Specify the source info file (line numbers for fields/classes).

Parameters:

sourceInfo - the source info file

Returns:

this operation

See Also:

• sourceInfo(String)
• sourceInfo(File)
• sourceInfo()

sourceInfo

public File sourceInfo()

Returns the source info file containing line numbers for fields/classes.

Returns:

the source info file

See Also:

• sourceInfo(String)
• sourceInfo(File)
• sourceInfo(Path)

sourcePath

public SpotBugsOperation sourcePath(String... path)

Set the source path for analyzed classes.

Parameters:

path - the source path

Returns:

this operation

See Also:

• sourcePath(Path...)
• sourcePath(File...)
• sourcePath(Collection...)
• sourcePath()

sourcePath

public SpotBugsOperation sourcePath(Path... path)

Set the source path for analyzed classes.

Parameters:

path - the source path

Returns:

this operation

See Also:

• sourcePath(String...)
• sourcePath(File...)
• sourcePath(Collection...)
• sourcePath()

sourcePath

public SpotBugsOperation sourcePath(File... path)

Set the source path for analyzed classes.

Parameters:

path - the source path

Returns:

this operation

See Also:

• sourcePath(String...)
• sourcePath(Path...)
• sourcePath(Collection...)
• sourcePath()

sourcePath

public List<String> sourcePath()

Returns the source path for analyzed classes.

Returns:

a collection containing the source paths

See Also:

• sourcePath(String...)
• sourcePath(Path...)
• sourcePath(File...)
• sourcePath(Collection...)

sourcePath

@SafeVarargs
public final SpotBugsOperation sourcePath(Collection<String>... path)

Set the source path for analyzed classes.

Parameters:

path - the source path

Returns:

this operation

See Also:

• sourcePath(String...)
• sourcePath(Path...)
• sourcePath(File...)
• sourcePath()

sourcePathFiles

@SafeVarargs
public final SpotBugsOperation sourcePathFiles(Collection<File>... path)

Set the source path for analyzed classes.

Parameters:

path - the source path

Returns:

this operation

See Also:

• sourcePath(String...)
• sourcePath(Path...)
• sourcePath(File...)
• sourcePath()

sourcePathPaths

@SafeVarargs
public final SpotBugsOperation sourcePathPaths(Collection<Path>... path)

Set the source path for analyzed classes.

Parameters:

path - the source path

Returns:

this operation

See Also:

• sourcePath(String...)
• sourcePath(Path...)
• sourcePath(File...)
• sourcePath()

spotBugsJar

public File spotBugsJar()

Returns the SpotBugs jar file.

Returns:

the SpotBugs jar file

See Also:

• spotBugsJar(String)
• spotBugsJar(File)
• spotBugsJar(Path)

spotBugsJar

public SpotBugsOperation spotBugsJar(String jar)

Sets the SpotBugs jar file.

Parameters:

jar - the SpotBugs jar file

Returns:

this operation

See Also:

• spotBugsJar(File)
• spotBugsJar(Path)
• spotBugsJar()

spotBugsJar

public SpotBugsOperation spotBugsJar(Path jarPath)

Sets the SpotBugs jar file.

Parameters:

jarPath - the SpotBugs jar file

Returns:

this operation

See Also:

• spotBugsJar(File)
• spotBugsJar(String)
• spotBugsJar()

spotBugsJar

public SpotBugsOperation spotBugsJar(File jar)

Sets the SpotBugs jar file.

Parameters:

jar - the SpotBugs jar file

Returns:

this operation

See Also:

• spotBugsJar(String)
• spotBugsJar(Path)
• spotBugsJar()

timestampNow

public SpotBugsOperation timestampNow(boolean timeStampNow)

Set the timestamp of results to be the current time.

Parameters:

timeStampNow - set to true to enable, false otherwise

Returns:

this operation

See Also:

• timestampNow()

timestampNow

public boolean timestampNow()

Returns whether the timestamp of results will be set to the current time.

Returns:

true if timestampNow is enabled, false otherwise

See Also:

• timestampNow(boolean)

visitors

public SpotBugsOperation visitors(String... visitors)

Run only named visitors.

Parameters:

visitors - the visitors to run

Returns:

this operation

See Also:

• visitors(Collection...)
• visitors()

visitors

@SafeVarargs
public final SpotBugsOperation visitors(Collection<String>... visitors)

Run only named visitors.

Parameters:

visitors - the visitors to run

Returns:

this operation

See Also:

• visitors(String...)
• visitors()

visitors

public List<String> visitors()

Returns the collection of named visitors to run.

Returns:

a collection containing the visitors

See Also:

• visitors(String...)
• visitors(Collection...)

workHard

public SpotBugsOperation workHard(boolean workHard)

Ensure analysis effort is at least Effort.DEFAULT.

Parameters:

workHard - set to true to enable, false otherwise

Returns:

this operation

See Also:

• workHard()

workHard

public boolean workHard()

Returns whether analysis effort should be at least Effort.DEFAULT.

Returns:

true if enabled, false otherwise

See Also:

• workHard(boolean)