Class ReportingDescriptor

java.lang.Object
se.bjurr.violations.lib.model.generated.sarif.ReportingDescriptor

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

    • ReportingDescriptor

      public ReportingDescriptor()
  • Method Details

    • getId

      public String getId()
      A stable, opaque identifier for the report. (Required)
    • setId

      public void setId(String id)
      A stable, opaque identifier for the report. (Required)
    • withId

      public ReportingDescriptor withId(String id)
    • getDeprecatedIds

      public Set<String> getDeprecatedIds()
      An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.
    • setDeprecatedIds

      public void setDeprecatedIds(Set<String> deprecatedIds)
      An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.
    • withDeprecatedIds

      public ReportingDescriptor withDeprecatedIds(Set<String> deprecatedIds)
    • getGuid

      public String getGuid()
      A unique identifer for the reporting descriptor in the form of a GUID.
    • setGuid

      public void setGuid(String guid)
      A unique identifer for the reporting descriptor in the form of a GUID.
    • withGuid

      public ReportingDescriptor withGuid(String guid)
    • getDeprecatedGuids

      public Set<String> 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

      public void setDeprecatedGuids(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.
    • withDeprecatedGuids

      public ReportingDescriptor withDeprecatedGuids(Set<String> deprecatedGuids)
    • getName

      public String getName()
      A report identifier that is understandable to an end user.
    • setName

      public void setName(String name)
      A report identifier that is understandable to an end user.
    • withName

      public ReportingDescriptor withName(String name)
    • getDeprecatedNames

      public Set<String> getDeprecatedNames()
      An array of readable identifiers by which this report was known in some previous version of the analysis tool.
    • setDeprecatedNames

      public void setDeprecatedNames(Set<String> deprecatedNames)
      An array of readable identifiers by which this report was known in some previous version of the analysis tool.
    • withDeprecatedNames

      public ReportingDescriptor withDeprecatedNames(Set<String> deprecatedNames)
    • getShortDescription

      public MultiformatMessageString getShortDescription()
      A message string or message format string rendered in multiple formats.
    • setShortDescription

      public void setShortDescription(MultiformatMessageString shortDescription)
      A message string or message format string rendered in multiple formats.
    • withShortDescription

      public ReportingDescriptor withShortDescription(MultiformatMessageString shortDescription)
    • getFullDescription

      public MultiformatMessageString getFullDescription()
      A message string or message format string rendered in multiple formats.
    • setFullDescription

      public void setFullDescription(MultiformatMessageString fullDescription)
      A message string or message format string rendered in multiple formats.
    • withFullDescription

      public ReportingDescriptor withFullDescription(MultiformatMessageString fullDescription)
    • getMessageStrings

      public MessageStrings 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

      public void setMessageStrings(MessageStrings 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.
    • withMessageStrings

      public ReportingDescriptor withMessageStrings(MessageStrings messageStrings)
    • getDefaultConfiguration

      public ReportingConfiguration getDefaultConfiguration()
      Information about a rule or notification that can be configured at runtime.
    • setDefaultConfiguration

      public void setDefaultConfiguration(ReportingConfiguration defaultConfiguration)
      Information about a rule or notification that can be configured at runtime.
    • withDefaultConfiguration

      public ReportingDescriptor withDefaultConfiguration(ReportingConfiguration defaultConfiguration)
    • getHelpUri

      public URI getHelpUri()
      A URI where the primary documentation for the report can be found.
    • setHelpUri

      public void setHelpUri(URI helpUri)
      A URI where the primary documentation for the report can be found.
    • withHelpUri

      public ReportingDescriptor withHelpUri(URI helpUri)
    • getHelp

      public MultiformatMessageString getHelp()
      A message string or message format string rendered in multiple formats.
    • setHelp

      public void setHelp(MultiformatMessageString help)
      A message string or message format string rendered in multiple formats.
    • withHelp

    • getRelationships

      public Set<ReportingDescriptorRelationship> getRelationships()
      An array of objects that describe relationships between this reporting descriptor and others.
    • setRelationships

      public void setRelationships(Set<ReportingDescriptorRelationship> relationships)
      An array of objects that describe relationships between this reporting descriptor and others.
    • withRelationships

      public ReportingDescriptor withRelationships(Set<ReportingDescriptorRelationship> relationships)
    • getProperties

      public PropertyBag getProperties()
      Key/value pairs that provide additional information about the object.
    • setProperties

      public void setProperties(PropertyBag properties)
      Key/value pairs that provide additional information about the object.
    • withProperties

      public ReportingDescriptor withProperties(PropertyBag properties)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object