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

Class SarifLog.Result

java.lang.Object

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

Enclosing class:

SarifLog

public static class SarifLog.Result
extends Object

A result produced by an analysis tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SarifLog.Result.ResultBuilder

Method Summary

Modifier and Type	Method	Description
static SarifLog.Result.ResultBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SarifLog.Location>	getLocations()	The set of locations where the result was detected.
SarifLog.Message	getMessage()	A message that describes the result.
SarifLog.PropertyBag	getProperties()	Key/value pairs that provide additional information about the address.
String	getRuleId()	The stable, unique identifier of the rule, if any, to which this result is relevant.
Integer	getRuleIndex()	The index link the rule, if any, to which this result is relevant.
int	hashCode()
SarifLog.Result	setLocations(List<SarifLog.Location> locations)	The set of locations where the result was detected.
SarifLog.Result	setMessage(SarifLog.Message message)	A message that describes the result.
SarifLog.Result	setProperties(SarifLog.PropertyBag properties)	Key/value pairs that provide additional information about the address.
SarifLog.Result	setRuleId(String ruleId)	The stable, unique identifier of the rule, if any, to which this result is relevant.
SarifLog.Result	setRuleIndex(Integer ruleIndex)	The index link the rule, if any, to which this result is relevant.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SarifLog.Result.ResultBuilder builder()

getRuleId

public String getRuleId()

The stable, unique identifier of the rule, if any, to which this result is relevant.

getRuleIndex

public Integer getRuleIndex()

The index link the rule, if any, to which this result is relevant.

getMessage

public SarifLog.Message getMessage()

A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

getLocations

public List<SarifLog.Location> getLocations()

The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

getProperties

public SarifLog.PropertyBag getProperties()

Key/value pairs that provide additional information about the address.

setRuleId

public SarifLog.Result setRuleId(String ruleId)

The stable, unique identifier of the rule, if any, to which this result is relevant.

Returns:

this.

setRuleIndex

public SarifLog.Result setRuleIndex(Integer ruleIndex)

The index link the rule, if any, to which this result is relevant.

Returns:

this.

setMessage

public SarifLog.Result setMessage(SarifLog.Message message)

A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

Returns:

this.

setLocations

public SarifLog.Result setLocations(List<SarifLog.Location> locations)

The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

Returns:

this.

setProperties

public SarifLog.Result setProperties(SarifLog.PropertyBag properties)

Key/value pairs that provide additional information about the address.

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