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

Class SarifLog.Run

java.lang.Object

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

Enclosing class:

SarifLog

public static class SarifLog.Run
extends Object

Describes a single run of an analysis tool, and contains the reported output of that run.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SarifLog.Run.RunBuilder

Method Summary

Modifier and Type	Method	Description
static SarifLog.Run.RunBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SarifLog.Invocation>	getInvocations()	The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions
List<SarifLog.Result>	getResults()	The set of results contained in an SARIF log.
SarifLog.Tool	getTool()	Information about the tool or tool pipeline that generated the results in this run.
int	hashCode()
SarifLog.Run	setInvocations(List<SarifLog.Invocation> invocations)	The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions
SarifLog.Run	setResults(List<SarifLog.Result> results)	The set of results contained in an SARIF log.
SarifLog.Run	setTool(SarifLog.Tool tool)	Information about the tool or tool pipeline that generated the results in this run.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SarifLog.Run.RunBuilder builder()

getTool

public SarifLog.Tool getTool()

Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

getResults

public List<SarifLog.Result> getResults()

The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

getInvocations

public List<SarifLog.Invocation> getInvocations()

The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions

setTool

public SarifLog.Run setTool(SarifLog.Tool tool)

Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

Returns:

this.

setResults

public SarifLog.Run setResults(List<SarifLog.Result> results)

The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

Returns:

this.

setInvocations

public SarifLog.Run setInvocations(List<SarifLog.Invocation> invocations)

The set of invocations providing information about the tool execution such as configuration errors or runtime exceptions

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