Class ReportingDescriptor
java.lang.Object
se.bjurr.violations.lib.model.generated.sarif.ReportingDescriptor
Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanInformation about a rule or notification that can be configured at runtime.An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.An array of readable identifiers by which this report was known in some previous version of the analysis tool.A message string or message format string rendered in multiple formats.getGuid()A unique identifer for the reporting descriptor in the form of a GUID.getHelp()A message string or message format string rendered in multiple formats.A URI where the primary documentation for the report can be found.getId()A stable, opaque identifier for the report.A set of name/value pairs with arbitrary names.getName()A report identifier that is understandable to an end user.Key/value pairs that provide additional information about the object.An array of objects that describe relationships between this reporting descriptor and others.A message string or message format string rendered in multiple formats.inthashCode()voidsetDefaultConfiguration(ReportingConfiguration defaultConfiguration) Information about a rule or notification that can be configured at runtime.voidsetDeprecatedGuids(Set<String> deprecatedGuids) An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.voidsetDeprecatedIds(Set<String> deprecatedIds) An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.voidsetDeprecatedNames(Set<String> deprecatedNames) An array of readable identifiers by which this report was known in some previous version of the analysis tool.voidsetFullDescription(MultiformatMessageString fullDescription) A message string or message format string rendered in multiple formats.voidA unique identifer for the reporting descriptor in the form of a GUID.voidA message string or message format string rendered in multiple formats.voidsetHelpUri(URI helpUri) A URI where the primary documentation for the report can be found.voidA stable, opaque identifier for the report.voidsetMessageStrings(MessageStrings messageStrings) A set of name/value pairs with arbitrary names.voidA report identifier that is understandable to an end user.voidsetProperties(PropertyBag properties) Key/value pairs that provide additional information about the object.voidsetRelationships(Set<ReportingDescriptorRelationship> relationships) An array of objects that describe relationships between this reporting descriptor and others.voidsetShortDescription(MultiformatMessageString shortDescription) A message string or message format string rendered in multiple formats.toString()withDefaultConfiguration(ReportingConfiguration defaultConfiguration) withDeprecatedGuids(Set<String> deprecatedGuids) withDeprecatedIds(Set<String> deprecatedIds) withDeprecatedNames(Set<String> deprecatedNames) withFullDescription(MultiformatMessageString fullDescription) withHelpUri(URI helpUri) withMessageStrings(MessageStrings messageStrings) withProperties(PropertyBag properties) withRelationships(Set<ReportingDescriptorRelationship> relationships) withShortDescription(MultiformatMessageString shortDescription)
-
Constructor Details
-
ReportingDescriptor
public ReportingDescriptor()
-
-
Method Details
-
getId
A stable, opaque identifier for the report. (Required) -
setId
A stable, opaque identifier for the report. (Required) -
withId
-
getDeprecatedIds
An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool. -
setDeprecatedIds
An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool. -
withDeprecatedIds
-
getGuid
A unique identifer for the reporting descriptor in the form of a GUID. -
setGuid
A unique identifer for the reporting descriptor in the form of a GUID. -
withGuid
-
getDeprecatedGuids
An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool. -
setDeprecatedGuids
An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool. -
withDeprecatedGuids
-
getName
A report identifier that is understandable to an end user. -
setName
A report identifier that is understandable to an end user. -
withName
-
getDeprecatedNames
An array of readable identifiers by which this report was known in some previous version of the analysis tool. -
setDeprecatedNames
An array of readable identifiers by which this report was known in some previous version of the analysis tool. -
withDeprecatedNames
-
getShortDescription
A message string or message format string rendered in multiple formats. -
setShortDescription
A message string or message format string rendered in multiple formats. -
withShortDescription
-
getFullDescription
A message string or message format string rendered in multiple formats. -
setFullDescription
A message string or message format string rendered in multiple formats. -
withFullDescription
-
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. -
setMessageStrings
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. -
withMessageStrings
-
getDefaultConfiguration
Information about a rule or notification that can be configured at runtime. -
setDefaultConfiguration
Information about a rule or notification that can be configured at runtime. -
withDefaultConfiguration
-
getHelpUri
A URI where the primary documentation for the report can be found. -
setHelpUri
A URI where the primary documentation for the report can be found. -
withHelpUri
-
getHelp
A message string or message format string rendered in multiple formats. -
setHelp
A message string or message format string rendered in multiple formats. -
withHelp
-
getRelationships
An array of objects that describe relationships between this reporting descriptor and others. -
setRelationships
An array of objects that describe relationships between this reporting descriptor and others. -
withRelationships
-
getProperties
Key/value pairs that provide additional information about the object. -
setProperties
Key/value pairs that provide additional information about the object. -
withProperties
-
toString
-
hashCode
public int hashCode() -
equals
-