Package net.sourceforge.pmd.renderers.internal.sarif

Class SarifLog

java.lang.Object

net.sourceforge.pmd.renderers.internal.sarif.SarifLog

public class SarifLog
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SarifLog.ArtifactLocation	Specifies the location of an artifact.
static class	SarifLog.AssociatedRule	A associated rule to the toolConfigurationNotification.
static class	SarifLog.Component	A component, such as a plug-in or the driver, of the analysis tool that was run.
static class	SarifLog.Exception	A exception information object, for the tool runtime errors.
static class	SarifLog.Invocation	An invocation component to specify tool invocation details/errors.
static class	SarifLog.Location	A location within a programming artifact.
static class	SarifLog.Message	Encapsulates a message intended to be read by the end user.
static class	SarifLog.MultiformatMessage	A message string or message format string rendered in multiple formats.
static class	SarifLog.PhysicalLocation	A physical location relevant to a result.
static class	SarifLog.PropertyBag	Key/value pairs that provide additional information about the object.
static class	SarifLog.Region	A region within an artifact where a result was detected.
static class	SarifLog.ReportingDescriptor	Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.
static class	SarifLog.Result	A result produced by an analysis tool.
static class	SarifLog.Run	Describes a single run of an analysis tool, and contains the reported output of that run.
static class	SarifLog.SarifLogBuilder
static class	SarifLog.Tool	The analysis tool that was run.
static class	SarifLog.ToolConfigurationNotification	An invocation property to specify tool configuration errors.
static class	SarifLog.ToolExecutionNotification	An invocation property to specify tool runtime errors.

Method Summary

Modifier and Type	Method	Description
static SarifLog.SarifLogBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SarifLog.Run>	getRuns()	The set of runs contained in this log file.
String	getSchema()	The URI of the JSON schema corresponding to the version.
String	getVersion()	The SARIF format version of this log file.
int	hashCode()
SarifLog	setRuns(List<SarifLog.Run> runs)	The set of runs contained in this log file.
SarifLog	setSchema(String schema)	The URI of the JSON schema corresponding to the version.
SarifLog	setVersion(String version)	The SARIF format version of this log file.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static SarifLog.SarifLogBuilder builder()

getSchema

public String getSchema()

The URI of the JSON schema corresponding to the version.

getVersion

public String getVersion()

The SARIF format version of this log file.

getRuns

public List<SarifLog.Run> getRuns()

The set of runs contained in this log file.

setSchema

public SarifLog setSchema(String schema)

The URI of the JSON schema corresponding to the version.

Returns:

this.

setVersion

public SarifLog setVersion(String version)

The SARIF format version of this log file.

Returns:

this.

setRuns

public SarifLog setRuns(List<SarifLog.Run> runs)

The set of runs contained in this log file.

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object