spotbugs.adoc

Scanner for SpotBugs and FindBugs report files

Scanner for SpotBugs and FindBugs report files

Accepts all files with the given file name (default: spotbugs.xml or findbugs.xml) or being in a directory named 'spotbugs' or 'findbugs' and end with '.xml'.

Note that the structure of SpotBugs and FindBugs XML files differ. So e.g. there are no sourceline, method or class XML elements in SpotBugs. Hence, there are also no such nodes in the SpotBugs graph.

Table 1. Configuration parameters

Name	Description
jqassistant.plugin.spotbugs.filename	Optional: file name of the FindBugs XML report file. Default: spotbugs.xml
jqassistant.plugin.spotbugs.dirname	Optional: name of the directory containing an XML. Default: Default: spotbugs

:SpotBugs:FindBugs:File:Report

Represents a SpotBugs or FindBugs report file.

Table 2. Properties

Name	Description
name	The file name.
fileName	The absolute file name.
version	SpotBugs/FindBugs version number.
analysisTimestamp	Epoch time stamp of analysis run.

Table 3. Relations

Name	Target label(s)	Cardinality	Description
CONTAINS	:SpotBugs:FindBugs:BugInstance	0..n	A SpotBugs or FindBugs issue

:SpotBugs:FindBugs:BugInstance

Represents a SpotBugs or FindBugs issue. Has all fields of a [:FindBugs:SourceLine].

Table 4. Properties

Name	Description
type	FindBugs keyword for the bug type, e.g. UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD
priority	Bug priority, e.g. 1
abbrev	Abbreviation of the keyword, e.g. UwF
category	Bug category, e.g. STYLE

Table 5. Relations

Name	Target label(s)	Cardinality	Description
HAS_SOURCELINE	[:FindBugs:SourceLine]	0..n	The the source line for a FindBugs issue
HAS_CLASS	[:FindBugs:BugInstanceClass]	0..n	The class of a FindBugs issue
HAS_METHOD	[:FindBugs:BugInstanceMethod]	0..n	The method of a FindBugs issue
HAS_FIELD	[:FindBugs:BugInstanceField]	0..n	The field of a FindBugs issue

:SpotBugs:FindBugs:BugInstanceClass

Represents the class for a FindBugs issue. Has all fields of a [:FindBugs:SourceLine].

Table 6. Properties

Name	Description
fqn	The class' fully qualified name.

:SpotBugs:FindBugs:BugInstanceMethod

Represents the method for a FindBugs issue. Has all fields of a [:FindBugs:SourceLine].

Table 7. Properties

Name	Description
name	The method name.
signature	Text representation of the method signature.
isStatic	true if the method is static, false otherwise.

:SpotBugs:FindBugs:BugInstanceField

Represents the field for a FindBugs issue. Has all fields of a [:FindBugs:SourceLine].

Table 8. Properties

Name	Description
name	The field name.
signature	Text representation of the field signature.
isStatic	true if the field is static, false otherwise.

:SpotBugs:FindBugs:SourceLine

Represents the source line for a FindBugs issue.

Table 9. Properties

Name	Description
fqn	Fully Qualified Name of the class
start	Start line number
end	End line number
sourceFile	The source file.
sourcePath	Path to source file incl. source file.