ToolComponent (sarif-2.1.0 1.1.0 API)

java.lang.Object
- de.jcup.sarif_2_1_0.model.ToolComponent

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

Constructor Summary

Constructors
Constructor and Description

ToolComponent()

Constructors
Constructor and Description
`ToolComponent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`ToolComponentReference`	`getAssociatedComponent()` Identifies a particular toolComponent object, either the driver or an extension.
`java.util.Set<Content>`	`getContents()` The kinds of data contained in this object.
`java.lang.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).
`java.net.URI`	`getDownloadUri()` The absolute URI from which the tool component can be downloaded.
`MultiformatMessageString`	`getFullDescription()` A message string or message format string rendered in multiple formats.
`java.lang.String`	`getFullName()` The name of the tool component along with its version and any other useful identifying information, such as its locale.
`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.
`java.lang.String`	`getGuid()` A unique identifier for the tool component in the form of a GUID.
`java.net.URI`	`getInformationUri()` The absolute URI at which information about this version of the tool component can be found.
`java.lang.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.
`java.lang.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).
`java.lang.String`	`getLocalizedDataSemanticVersion()` The semantic version of the localized strings defined in this component; maintained by components that provide translations.
`java.util.List<ArtifactLocation>`	`getLocations()` An array of the artifactLocation objects associated with the tool component.
`java.lang.String`	`getMinimumRequiredLocalizedDataSemanticVersion()` The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
`java.lang.String`	`getName()` The name of the tool component.
`java.util.Set<ReportingDescriptor>`	`getNotifications()` An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
`java.lang.String`	`getOrganization()` The organization or company that produced the tool component.
`java.lang.String`	`getProduct()` A product suite to which the tool component belongs.
`java.lang.String`	`getProductSuite()` A localizable string containing the name of the suite of products to which the tool component belongs.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`java.lang.String`	`getReleaseDateUtc()` A string specifying the UTC date (and optionally, the time) of the component's release.
`java.util.Set<ReportingDescriptor>`	`getRules()` An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
`java.lang.String`	`getSemanticVersion()` The tool component version in the format specified by Semantic Versioning 2.0.
`MultiformatMessageString`	`getShortDescription()` A message string or message format string rendered in multiple formats.
`java.util.Set<ToolComponentReference>`	`getSupportedTaxonomies()` An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
`java.util.Set<ReportingDescriptor>`	`getTaxa()` An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
`TranslationMetadata`	`getTranslationMetadata()` Provides additional metadata related to translation.
`java.lang.String`	`getVersion()` The tool component version, in whatever format the component natively provides.
`int`	`hashCode()`
`void`	`setAssociatedComponent(ToolComponentReference associatedComponent)` Identifies a particular toolComponent object, either the driver or an extension.
`void`	`setContents(java.util.Set<Content> contents)` The kinds of data contained in this object.
`void`	`setDottedQuadFileVersion(java.lang.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).
`void`	`setDownloadUri(java.net.URI downloadUri)` The absolute URI from which the tool component can be downloaded.
`void`	`setFullDescription(MultiformatMessageString fullDescription)` A message string or message format string rendered in multiple formats.
`void`	`setFullName(java.lang.String fullName)` The name of the tool component along with its version and any other useful identifying information, such as its locale.
`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.
`void`	`setGuid(java.lang.String guid)` A unique identifier for the tool component in the form of a GUID.
`void`	`setInformationUri(java.net.URI informationUri)` The absolute URI at which information about this version of the tool component can be found.
`void`	`setIsComprehensive(java.lang.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.
`void`	`setLanguage(java.lang.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).
`void`	`setLocalizedDataSemanticVersion(java.lang.String localizedDataSemanticVersion)` The semantic version of the localized strings defined in this component; maintained by components that provide translations.
`void`	`setLocations(java.util.List<ArtifactLocation> locations)` An array of the artifactLocation objects associated with the tool component.
`void`	`setMinimumRequiredLocalizedDataSemanticVersion(java.lang.String minimumRequiredLocalizedDataSemanticVersion)` The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
`void`	`setName(java.lang.String name)` The name of the tool component.
`void`	`setNotifications(java.util.Set<ReportingDescriptor> notifications)` An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
`void`	`setOrganization(java.lang.String organization)` The organization or company that produced the tool component.
`void`	`setProduct(java.lang.String product)` A product suite to which the tool component belongs.
`void`	`setProductSuite(java.lang.String productSuite)` A localizable string containing the name of the suite of products to which the tool component belongs.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setReleaseDateUtc(java.lang.String releaseDateUtc)` A string specifying the UTC date (and optionally, the time) of the component's release.
`void`	`setRules(java.util.Set<ReportingDescriptor> rules)` An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
`void`	`setSemanticVersion(java.lang.String semanticVersion)` The tool component version in the format specified by Semantic Versioning 2.0.
`void`	`setShortDescription(MultiformatMessageString shortDescription)` A message string or message format string rendered in multiple formats.
`void`	`setSupportedTaxonomies(java.util.Set<ToolComponentReference> supportedTaxonomies)` An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
`void`	`setTaxa(java.util.Set<ReportingDescriptor> taxa)` An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
`void`	`setTranslationMetadata(TranslationMetadata translationMetadata)` Provides additional metadata related to translation.
`void`	`setVersion(java.lang.String version)` The tool component version, in whatever format the component natively provides.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - ToolComponent
```
public ToolComponent()
```
- Method Detail
  - getGuid
```
public java.lang.String getGuid()
```
    A unique identifier for the tool component in the form of a GUID.
  - setGuid
```
public void setGuid(java.lang.String guid)
```
    A unique identifier for the tool component in the form of a GUID.
  - getName
```
public java.lang.String getName()
```
    The name of the tool component. (Required)
  - setName
```
public void setName(java.lang.String name)
```
    The name of the tool component. (Required)
  - getOrganization
```
public java.lang.String getOrganization()
```
    The organization or company that produced the tool component.
  - setOrganization
```
public void setOrganization(java.lang.String organization)
```
    The organization or company that produced the tool component.
  - getProduct
```
public java.lang.String getProduct()
```
    A product suite to which the tool component belongs.
  - setProduct
```
public void setProduct(java.lang.String product)
```
    A product suite to which the tool component belongs.
  - getProductSuite
```
public java.lang.String getProductSuite()
```
    A localizable string containing the name of the suite of products to which the tool component belongs.
  - setProductSuite
```
public void setProductSuite(java.lang.String productSuite)
```
    A localizable string containing the name of the suite of products to which the tool component belongs.
  - 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.
  - 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.
  - getFullName
```
public java.lang.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(java.lang.String fullName)
```
    The name of the tool component along with its version and any other useful identifying information, such as its locale.
  - getVersion
```
public java.lang.String getVersion()
```
    The tool component version, in whatever format the component natively provides.
  - setVersion
```
public void setVersion(java.lang.String version)
```
    The tool component version, in whatever format the component natively provides.
  - getSemanticVersion
```
public java.lang.String getSemanticVersion()
```
    The tool component version in the format specified by Semantic Versioning 2.0.
  - setSemanticVersion
```
public void setSemanticVersion(java.lang.String semanticVersion)
```
    The tool component version in the format specified by Semantic Versioning 2.0.
  - getDottedQuadFileVersion
```
public java.lang.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(java.lang.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).
  - getReleaseDateUtc
```
public java.lang.String getReleaseDateUtc()
```
    A string specifying the UTC date (and optionally, the time) of the component's release.
  - setReleaseDateUtc
```
public void setReleaseDateUtc(java.lang.String releaseDateUtc)
```
    A string specifying the UTC date (and optionally, the time) of the component's release.
  - getDownloadUri
```
public java.net.URI getDownloadUri()
```
    The absolute URI from which the tool component can be downloaded.
  - setDownloadUri
```
public void setDownloadUri(java.net.URI downloadUri)
```
    The absolute URI from which the tool component can be downloaded.
  - getInformationUri
```
public java.net.URI getInformationUri()
```
    The absolute URI at which information about this version of the tool component can be found.
  - setInformationUri
```
public void setInformationUri(java.net.URI informationUri)
```
    The absolute URI at which information about this version of the tool component can be found.
  - 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.
  - getNotifications
```
public java.util.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(java.util.Set<ReportingDescriptor> notifications)
```
    An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
  - getRules
```
public java.util.Set<ReportingDescriptor> getRules()
```
    An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
  - setRules
```
public void setRules(java.util.Set<ReportingDescriptor> rules)
```
    An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
  - getTaxa
```
public java.util.Set<ReportingDescriptor> getTaxa()
```
    An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
  - setTaxa
```
public void setTaxa(java.util.Set<ReportingDescriptor> taxa)
```
    An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
  - getLocations
```
public java.util.List<ArtifactLocation> getLocations()
```
    An array of the artifactLocation objects associated with the tool component.
  - setLocations
```
public void setLocations(java.util.List<ArtifactLocation> locations)
```
    An array of the artifactLocation objects associated with the tool component.
  - getLanguage
```
public java.lang.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(java.lang.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).
  - getContents
```
public java.util.Set<Content> getContents()
```
    The kinds of data contained in this object.
  - setContents
```
public void setContents(java.util.Set<Content> contents)
```
    The kinds of data contained in this object.
  - getIsComprehensive
```
public java.lang.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(java.lang.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.
  - getLocalizedDataSemanticVersion
```
public java.lang.String getLocalizedDataSemanticVersion()
```
    The semantic version of the localized strings defined in this component; maintained by components that provide translations.
  - setLocalizedDataSemanticVersion
```
public void setLocalizedDataSemanticVersion(java.lang.String localizedDataSemanticVersion)
```
    The semantic version of the localized strings defined in this component; maintained by components that provide translations.
  - getMinimumRequiredLocalizedDataSemanticVersion
```
public java.lang.String getMinimumRequiredLocalizedDataSemanticVersion()
```
    The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
  - setMinimumRequiredLocalizedDataSemanticVersion
```
public void setMinimumRequiredLocalizedDataSemanticVersion(java.lang.String minimumRequiredLocalizedDataSemanticVersion)
```
    The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
  - 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.
  - getTranslationMetadata
```
public TranslationMetadata getTranslationMetadata()
```
    Provides additional metadata related to translation.
  - setTranslationMetadata
```
public void setTranslationMetadata(TranslationMetadata translationMetadata)
```
    Provides additional metadata related to translation.
  - getSupportedTaxonomies
```
public java.util.Set<ToolComponentReference> getSupportedTaxonomies()
```
    An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
  - setSupportedTaxonomies
```
public void setSupportedTaxonomies(java.util.Set<ToolComponentReference> supportedTaxonomies)
```
    An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
  - 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.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object

Class ToolComponent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ToolComponent

Method Detail

getGuid

setGuid

getName

setName

getOrganization

setOrganization

getProduct

setProduct

getProductSuite

setProductSuite

getShortDescription

setShortDescription

getFullDescription

setFullDescription

getFullName

setFullName

getVersion

setVersion

getSemanticVersion

setSemanticVersion

getDottedQuadFileVersion

setDottedQuadFileVersion

getReleaseDateUtc

setReleaseDateUtc

getDownloadUri

setDownloadUri

getInformationUri

setInformationUri

getGlobalMessageStrings

setGlobalMessageStrings

getNotifications

setNotifications

getRules

setRules

getTaxa

setTaxa

getLocations

setLocations

getLanguage

setLanguage

getContents

setContents

getIsComprehensive

setIsComprehensive

getLocalizedDataSemanticVersion

setLocalizedDataSemanticVersion

getMinimumRequiredLocalizedDataSemanticVersion

setMinimumRequiredLocalizedDataSemanticVersion

getAssociatedComponent

setAssociatedComponent

getTranslationMetadata

setTranslationMetadata

getSupportedTaxonomies

setSupportedTaxonomies

getProperties

setProperties

toString

hashCode

equals