SarifLog.Result.ResultBuilder (PMD Core 6.36.0 API)

java.lang.Object
- net.sourceforge.pmd.renderers.internal.sarif.SarifLog.Result.ResultBuilder

Enclosing class:: SarifLog.Result

public static class SarifLog.Result.ResultBuilder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SarifLog.Result`	`build()`
`SarifLog.Result.ResultBuilder`	`locations(List<SarifLog.Location> locations)`	The set of locations where the result was detected.
`SarifLog.Result.ResultBuilder`	`message(SarifLog.Message message)`	A message that describes the result.
`SarifLog.Result.ResultBuilder`	`properties(SarifLog.PropertyBag properties)`	Key/value pairs that provide additional information about the address.
`SarifLog.Result.ResultBuilder`	`ruleId(String ruleId)`	The stable, unique identifier of the rule, if any, to which this result is relevant.
`SarifLog.Result.ResultBuilder`	`ruleIndex(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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - ruleId
```
public SarifLog.Result.ResultBuilder ruleId(String ruleId)
```
    The stable, unique identifier of the rule, if any, to which this result is relevant.
    
    Returns:
    
    this.
  - ruleIndex
```
public SarifLog.Result.ResultBuilder ruleIndex(Integer ruleIndex)
```
    The index link the rule, if any, to which this result is relevant.
    
    Returns:
    
    this.
  - message
```
public SarifLog.Result.ResultBuilder message(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.
  - locations
```
public SarifLog.Result.ResultBuilder locations(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.
  - properties
```
public SarifLog.Result.ResultBuilder properties(SarifLog.PropertyBag properties)
```
    Key/value pairs that provide additional information about the address.
    
    Returns:
    
    this.
  - build
```
public SarifLog.Result build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object