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

Class SarifLog.ReportingDescriptor.ReportingDescriptorBuilder

java.lang.Object

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

Enclosing class:

SarifLog.ReportingDescriptor

public static class SarifLog.ReportingDescriptor.ReportingDescriptorBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SarifLog.ReportingDescriptor	build()
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	fullDescription(SarifLog.MultiformatMessage fullDescription)	A description of the report.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	help(SarifLog.MultiformatMessage help)	Provides the primary documentation for the report, useful when there is no online documentation.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	helpUri(String helpUri)	A URI where the primary documentation for the report can be found.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	id(String id)	A stable, opaque identifier for the report.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	messageStrings(SarifLog.MultiformatMessage messageStrings)	A set of name/value pairs with arbitrary names.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	name(String name)	A report identifier that is understandable to an end user.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	properties(SarifLog.PropertyBag properties)	Key/value pairs that provide additional information about the report.
SarifLog.ReportingDescriptor.ReportingDescriptorBuilder	shortDescription(SarifLog.MultiformatMessage shortDescription)	A concise description of the report.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

id

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder id(String id)

A stable, opaque identifier for the report.

Returns:

this.

name

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder name(String name)

A report identifier that is understandable to an end user.

Returns:

this.

shortDescription

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder shortDescription(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.

fullDescription

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder fullDescription(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.

messageStrings

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder messageStrings(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.

helpUri

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder helpUri(String helpUri)

A URI where the primary documentation for the report can be found.

Returns:

this.

help

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder help(SarifLog.MultiformatMessage help)

Provides the primary documentation for the report, useful when there is no online documentation.

Returns:

this.

properties

public SarifLog.ReportingDescriptor.ReportingDescriptorBuilder properties(SarifLog.PropertyBag properties)

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

Returns:

this.

build

public SarifLog.ReportingDescriptor build()

toString

public String toString()

Overrides:

toString in class Object