Package edu.umd.cs.findbugs.sarif

package edu.umd.cs.findbugs.sarif

The package providing a BugReporter implementation which produces report in SARIF format.

Mapping from SARIF concepts to SpotBugs concepts

SARIF	SpotBugs	Note
ruleId	BugPattern#type
results	BugInstance[]
shortDescription	BugPattern#shortDescription
messageStrings	BugPattern#longDescription
category	BugCategory
helpUri	BugPattern#url
level	Priorities
toolExecutionNotification	AbstractBugReporter#missingClasses AbstractBugReporter#queuedErrors
reportingDescriptor.helpUri	BugPattern#url

See Also:

• Static Analysis Results Interchange Format (SARIF) Version 2.1.0

Related Packages

Package	Description
edu.umd.cs.findbugs	Main package for the FindBugs application - contains the engine class (FindBugs), the object model classes for bug instances (BugInstance, BugAnnotation), and other miscellany.

Class	Description
BugCollectionAnalyser
Extension
GUIDCalculator	The GUID calculator class has methods to calculate UUIDs based on UUID version 5.
Invocation
Level	An enum representing level property.
Location
Location.ArtifactLocation
Location.LogicalLocation
Location.PhysicalLocation
Location.Region
Message	Object which represents message property.
MessageFormat	Class to parse longDescription to generate formatted test for SARIF.
Notification	A class representing notification object (§3.58) in run.invocations.toolExecutionNotifications (§3.20.21)
Placeholder
Result	Object which represents result object in run.results property.
Rule	Object which represents reportingDescriptor in run.driver.rules property.
SarifBugReporter
SarifException
Stack	A class representing stack object (§3.44)
Stack.StackFrame	A class representing stackFrame object (§3.45)
Taxon	A taxon SARIF element (see: §3.19.3).