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

Enclosing class:

SarifLog
```
public static class SarifLog.ReportingDescriptor
extends Object
```
Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SarifLog.ReportingDescriptor.ReportingDescriptorBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SarifLog.ReportingDescriptor.ReportingDescriptorBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`SarifLog.MultiformatMessage`	`getFullDescription()`	A description of the report.
`SarifLog.MultiformatMessage`	`getHelp()`	Provides the primary documentation for the report, useful when there is no online documentation.
`String`	`getHelpUri()`	A URI where the primary documentation for the report can be found.
`String`	`getId()`	A stable, opaque identifier for the report.
`SarifLog.MultiformatMessage`	`getMessageStrings()`	A set of name/value pairs with arbitrary names.
`String`	`getName()`	A report identifier that is understandable to an end user.
`SarifLog.PropertyBag`	`getProperties()`	Key/value pairs that provide additional information about the report.
`SarifLog.MultiformatMessage`	`getShortDescription()`	A concise description of the report.
`int`	`hashCode()`
`SarifLog.ReportingDescriptor`	`setFullDescription(SarifLog.MultiformatMessage fullDescription)`	A description of the report.
`SarifLog.ReportingDescriptor`	`setHelp(SarifLog.MultiformatMessage help)`	Provides the primary documentation for the report, useful when there is no online documentation.
`SarifLog.ReportingDescriptor`	`setHelpUri(String helpUri)`	A URI where the primary documentation for the report can be found.
`SarifLog.ReportingDescriptor`	`setId(String id)`	A stable, opaque identifier for the report.
`SarifLog.ReportingDescriptor`	`setMessageStrings(SarifLog.MultiformatMessage messageStrings)`	A set of name/value pairs with arbitrary names.
`SarifLog.ReportingDescriptor`	`setName(String name)`	A report identifier that is understandable to an end user.
`SarifLog.ReportingDescriptor`	`setProperties(SarifLog.PropertyBag properties)`	Key/value pairs that provide additional information about the report.
`SarifLog.ReportingDescriptor`	`setShortDescription(SarifLog.MultiformatMessage shortDescription)`	A concise description of the report.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static SarifLog.ReportingDescriptor.ReportingDescriptorBuilder builder()
```
  - getId
```
public String getId()
```
    A stable, opaque identifier for the report.
  - getName
```
public String getName()
```
    A report identifier that is understandable to an end user.
  - getShortDescription
```
public SarifLog.MultiformatMessage getShortDescription()
```
    A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.
  - getFullDescription
```
public SarifLog.MultiformatMessage getFullDescription()
```
    A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.
  - getMessageStrings
```
public SarifLog.MultiformatMessage getMessageStrings()
```
    A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.
  - getHelpUri
```
public String getHelpUri()
```
    A URI where the primary documentation for the report can be found.
  - getHelp
```
public SarifLog.MultiformatMessage getHelp()
```
    Provides the primary documentation for the report, useful when there is no online documentation.
  - getProperties
```
public SarifLog.PropertyBag getProperties()
```
    Key/value pairs that provide additional information about the report.
  - setId
```
public SarifLog.ReportingDescriptor setId(String id)
```
    A stable, opaque identifier for the report.
    
    Returns:
    
    this.
  - setName
```
public SarifLog.ReportingDescriptor setName(String name)
```
    A report identifier that is understandable to an end user.
    
    Returns:
    
    this.
  - setShortDescription
```
public SarifLog.ReportingDescriptor setShortDescription(SarifLog.MultiformatMessage shortDescription)
```
    A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.
    
    Returns:
    
    this.
  - setFullDescription
```
public SarifLog.ReportingDescriptor setFullDescription(SarifLog.MultiformatMessage fullDescription)
```
    A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.
    
    Returns:
    
    this.
  - setMessageStrings
```
public SarifLog.ReportingDescriptor setMessageStrings(SarifLog.MultiformatMessage messageStrings)
```
    A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.
    
    Returns:
    
    this.
  - setHelpUri
```
public SarifLog.ReportingDescriptor setHelpUri(String helpUri)
```
    A URI where the primary documentation for the report can be found.
    
    Returns:
    
    this.
  - setHelp
```
public SarifLog.ReportingDescriptor setHelp(SarifLog.MultiformatMessage help)
```
    Provides the primary documentation for the report, useful when there is no online documentation.
    
    Returns:
    
    this.
  - setProperties
```
public SarifLog.ReportingDescriptor setProperties(SarifLog.PropertyBag properties)
```
    Key/value pairs that provide additional information about the report.
    
    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

Class SarifLog.ReportingDescriptor

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getId

getName

getShortDescription

getFullDescription

getMessageStrings

getHelpUri

getHelp

getProperties

setId

setName

setShortDescription

setFullDescription

setMessageStrings

setHelpUri

setHelp

setProperties

equals

canEqual

hashCode

toString