Class ToolComponent

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

public class ToolComponent extends Object
A component, such as a plug-in or the driver, of the analysis tool that was run.
  • Constructor Details

    • ToolComponent

      public ToolComponent()
  • Method Details

    • getGuid

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

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

      public ToolComponent withGuid(String guid)
    • getName

      public String getName()
      The name of the tool component. (Required)
    • setName

      public void setName(String name)
      The name of the tool component. (Required)
    • withName

      public ToolComponent withName(String name)
    • getOrganization

      public String getOrganization()
      The organization or company that produced the tool component.
    • setOrganization

      public void setOrganization(String organization)
      The organization or company that produced the tool component.
    • withOrganization

      public ToolComponent withOrganization(String organization)
    • getProduct

      public String getProduct()
      A product suite to which the tool component belongs.
    • setProduct

      public void setProduct(String product)
      A product suite to which the tool component belongs.
    • withProduct

      public ToolComponent withProduct(String product)
    • getProductSuite

      public String getProductSuite()
      A localizable string containing the name of the suite of products to which the tool component belongs.
    • setProductSuite

      public void setProductSuite(String productSuite)
      A localizable string containing the name of the suite of products to which the tool component belongs.
    • withProductSuite

      public ToolComponent withProductSuite(String productSuite)
    • 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 ToolComponent 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 ToolComponent withFullDescription(MultiformatMessageString fullDescription)
    • getFullName

      public String getFullName()
      The name of the tool component along with its version and any other useful identifying information, such as its locale.
    • setFullName

      public void setFullName(String fullName)
      The name of the tool component along with its version and any other useful identifying information, such as its locale.
    • withFullName

      public ToolComponent withFullName(String fullName)
    • getVersion

      public String getVersion()
      The tool component version, in whatever format the component natively provides.
    • setVersion

      public void setVersion(String version)
      The tool component version, in whatever format the component natively provides.
    • withVersion

      public ToolComponent withVersion(String version)
    • getSemanticVersion

      public String getSemanticVersion()
      The tool component version in the format specified by Semantic Versioning 2.0.
    • setSemanticVersion

      public void setSemanticVersion(String semanticVersion)
      The tool component version in the format specified by Semantic Versioning 2.0.
    • withSemanticVersion

      public ToolComponent withSemanticVersion(String semanticVersion)
    • getDottedQuadFileVersion

      public String getDottedQuadFileVersion()
      The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).
    • setDottedQuadFileVersion

      public void setDottedQuadFileVersion(String dottedQuadFileVersion)
      The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).
    • withDottedQuadFileVersion

      public ToolComponent withDottedQuadFileVersion(String dottedQuadFileVersion)
    • getReleaseDateUtc

      public String getReleaseDateUtc()
      A string specifying the UTC date (and optionally, the time) of the component's release.
    • setReleaseDateUtc

      public void setReleaseDateUtc(String releaseDateUtc)
      A string specifying the UTC date (and optionally, the time) of the component's release.
    • withReleaseDateUtc

      public ToolComponent withReleaseDateUtc(String releaseDateUtc)
    • getDownloadUri

      public URI getDownloadUri()
      The absolute URI from which the tool component can be downloaded.
    • setDownloadUri

      public void setDownloadUri(URI downloadUri)
      The absolute URI from which the tool component can be downloaded.
    • withDownloadUri

      public ToolComponent withDownloadUri(URI downloadUri)
    • getInformationUri

      public URI getInformationUri()
      The absolute URI at which information about this version of the tool component can be found.
    • setInformationUri

      public void setInformationUri(URI informationUri)
      The absolute URI at which information about this version of the tool component can be found.
    • withInformationUri

      public ToolComponent withInformationUri(URI informationUri)
    • getGlobalMessageStrings

      public GlobalMessageStrings getGlobalMessageStrings()
      A dictionary, each of whose keys is a resource identifier and each of whose values 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.
    • setGlobalMessageStrings

      public void setGlobalMessageStrings(GlobalMessageStrings globalMessageStrings)
      A dictionary, each of whose keys is a resource identifier and each of whose values 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.
    • withGlobalMessageStrings

      public ToolComponent withGlobalMessageStrings(GlobalMessageStrings globalMessageStrings)
    • getNotifications

      public Set<ReportingDescriptor> getNotifications()
      An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
    • setNotifications

      public void setNotifications(Set<ReportingDescriptor> notifications)
      An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
    • withNotifications

      public ToolComponent withNotifications(Set<ReportingDescriptor> notifications)
    • getRules

      public Set<ReportingDescriptor> getRules()
      An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
    • setRules

      public void setRules(Set<ReportingDescriptor> rules)
      An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
    • withRules

      public ToolComponent withRules(Set<ReportingDescriptor> rules)
    • getTaxa

      public Set<ReportingDescriptor> getTaxa()
      An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
    • setTaxa

      public void setTaxa(Set<ReportingDescriptor> taxa)
      An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
    • withTaxa

      public ToolComponent withTaxa(Set<ReportingDescriptor> taxa)
    • getLocations

      public List<ArtifactLocation> getLocations()
      An array of the artifactLocation objects associated with the tool component.
    • setLocations

      public void setLocations(List<ArtifactLocation> locations)
      An array of the artifactLocation objects associated with the tool component.
    • withLocations

      public ToolComponent withLocations(List<ArtifactLocation> locations)
    • getLanguage

      public String getLanguage()
      The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).
    • setLanguage

      public void setLanguage(String language)
      The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).
    • withLanguage

      public ToolComponent withLanguage(String language)
    • getContents

      public Set<Object> getContents()
      The kinds of data contained in this object.
    • setContents

      public void setContents(Set<Object> contents)
      The kinds of data contained in this object.
    • withContents

      public ToolComponent withContents(Set<Object> contents)
    • getIsComprehensive

      public Boolean getIsComprehensive()
      Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.
    • setIsComprehensive

      public void setIsComprehensive(Boolean isComprehensive)
      Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.
    • withIsComprehensive

      public ToolComponent withIsComprehensive(Boolean isComprehensive)
    • getLocalizedDataSemanticVersion

      public String getLocalizedDataSemanticVersion()
      The semantic version of the localized strings defined in this component; maintained by components that provide translations.
    • setLocalizedDataSemanticVersion

      public void setLocalizedDataSemanticVersion(String localizedDataSemanticVersion)
      The semantic version of the localized strings defined in this component; maintained by components that provide translations.
    • withLocalizedDataSemanticVersion

      public ToolComponent withLocalizedDataSemanticVersion(String localizedDataSemanticVersion)
    • getMinimumRequiredLocalizedDataSemanticVersion

      public String getMinimumRequiredLocalizedDataSemanticVersion()
      The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
    • setMinimumRequiredLocalizedDataSemanticVersion

      public void setMinimumRequiredLocalizedDataSemanticVersion(String minimumRequiredLocalizedDataSemanticVersion)
      The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
    • withMinimumRequiredLocalizedDataSemanticVersion

      public ToolComponent withMinimumRequiredLocalizedDataSemanticVersion(String minimumRequiredLocalizedDataSemanticVersion)
    • getAssociatedComponent

      public ToolComponentReference getAssociatedComponent()
      Identifies a particular toolComponent object, either the driver or an extension.
    • setAssociatedComponent

      public void setAssociatedComponent(ToolComponentReference associatedComponent)
      Identifies a particular toolComponent object, either the driver or an extension.
    • withAssociatedComponent

      public ToolComponent withAssociatedComponent(ToolComponentReference associatedComponent)
    • getTranslationMetadata

      public TranslationMetadata getTranslationMetadata()
      Provides additional metadata related to translation.
    • setTranslationMetadata

      public void setTranslationMetadata(TranslationMetadata translationMetadata)
      Provides additional metadata related to translation.
    • withTranslationMetadata

      public ToolComponent withTranslationMetadata(TranslationMetadata translationMetadata)
    • getSupportedTaxonomies

      public Set<ToolComponentReference> getSupportedTaxonomies()
      An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
    • setSupportedTaxonomies

      public void setSupportedTaxonomies(Set<ToolComponentReference> supportedTaxonomies)
      An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
    • withSupportedTaxonomies

      public ToolComponent withSupportedTaxonomies(Set<ToolComponentReference> supportedTaxonomies)
    • 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 ToolComponent 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