Class ToolComponent
java.lang.Object
se.bjurr.violations.lib.model.generated.sarif.ToolComponent
A component, such as a plug-in or the driver, of the analysis tool that was run.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanIdentifies a particular toolComponent object, either the driver or an extension.The kinds of data contained in this object.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).The absolute URI from which the tool component can be downloaded.A message string or message format string rendered in multiple formats.The name of the tool component along with its version and any other useful identifying information, such as its locale.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.getGuid()A unique identifer for the tool component in the form of a GUID.The absolute URI at which information about this version of the tool component can be found.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.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 semantic version of the localized strings defined in this component; maintained by components that provide translations.An array of the artifactLocation objects associated with the tool component.The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.getName()The name of the tool component.An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.The organization or company that produced the tool component.A product suite to which the tool component belongs.A localizable string containing the name of the suite of products to which the tool component belongs.Key/value pairs that provide additional information about the object.A string specifying the UTC date (and optionally, the time) of the component's release.getRules()An array of reportingDescriptor objects relevant to the analysis performed by the tool component.The tool component version in the format specified by Semantic Versioning 2.0.A message string or message format string rendered in multiple formats.An array of toolComponentReference objects to declare the taxonomies supported by the tool component.getTaxa()An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.Provides additional metadata related to translation.The tool component version, in whatever format the component natively provides.inthashCode()voidsetAssociatedComponent(ToolComponentReference associatedComponent) Identifies a particular toolComponent object, either the driver or an extension.voidsetContents(Set<Object> contents) The kinds of data contained in this object.voidsetDottedQuadFileVersion(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).voidsetDownloadUri(URI downloadUri) The absolute URI from which the tool component can be downloaded.voidsetFullDescription(MultiformatMessageString fullDescription) A message string or message format string rendered in multiple formats.voidsetFullName(String fullName) The name of the tool component along with its version and any other useful identifying information, such as its locale.voidsetGlobalMessageStrings(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.voidA unique identifer for the tool component in the form of a GUID.voidsetInformationUri(URI informationUri) The absolute URI at which information about this version of the tool component can be found.voidsetIsComprehensive(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.voidsetLanguage(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).voidsetLocalizedDataSemanticVersion(String localizedDataSemanticVersion) The semantic version of the localized strings defined in this component; maintained by components that provide translations.voidsetLocations(List<ArtifactLocation> locations) An array of the artifactLocation objects associated with the tool component.voidsetMinimumRequiredLocalizedDataSemanticVersion(String minimumRequiredLocalizedDataSemanticVersion) The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.voidThe name of the tool component.voidsetNotifications(Set<ReportingDescriptor> notifications) An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.voidsetOrganization(String organization) The organization or company that produced the tool component.voidsetProduct(String product) A product suite to which the tool component belongs.voidsetProductSuite(String productSuite) A localizable string containing the name of the suite of products to which the tool component belongs.voidsetProperties(PropertyBag properties) Key/value pairs that provide additional information about the object.voidsetReleaseDateUtc(String releaseDateUtc) A string specifying the UTC date (and optionally, the time) of the component's release.voidsetRules(Set<ReportingDescriptor> rules) An array of reportingDescriptor objects relevant to the analysis performed by the tool component.voidsetSemanticVersion(String semanticVersion) The tool component version in the format specified by Semantic Versioning 2.0.voidsetShortDescription(MultiformatMessageString shortDescription) A message string or message format string rendered in multiple formats.voidsetSupportedTaxonomies(Set<ToolComponentReference> supportedTaxonomies) An array of toolComponentReference objects to declare the taxonomies supported by the tool component.voidsetTaxa(Set<ReportingDescriptor> taxa) An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.voidsetTranslationMetadata(TranslationMetadata translationMetadata) Provides additional metadata related to translation.voidsetVersion(String version) The tool component version, in whatever format the component natively provides.toString()withAssociatedComponent(ToolComponentReference associatedComponent) withContents(Set<Object> contents) withDottedQuadFileVersion(String dottedQuadFileVersion) withDownloadUri(URI downloadUri) withFullDescription(MultiformatMessageString fullDescription) withFullName(String fullName) withGlobalMessageStrings(GlobalMessageStrings globalMessageStrings) withInformationUri(URI informationUri) withIsComprehensive(Boolean isComprehensive) withLanguage(String language) withLocalizedDataSemanticVersion(String localizedDataSemanticVersion) withLocations(List<ArtifactLocation> locations) withMinimumRequiredLocalizedDataSemanticVersion(String minimumRequiredLocalizedDataSemanticVersion) withNotifications(Set<ReportingDescriptor> notifications) withOrganization(String organization) withProduct(String product) withProductSuite(String productSuite) withProperties(PropertyBag properties) withReleaseDateUtc(String releaseDateUtc) withRules(Set<ReportingDescriptor> rules) withSemanticVersion(String semanticVersion) withShortDescription(MultiformatMessageString shortDescription) withSupportedTaxonomies(Set<ToolComponentReference> supportedTaxonomies) withTaxa(Set<ReportingDescriptor> taxa) withTranslationMetadata(TranslationMetadata translationMetadata) withVersion(String version)
-
Constructor Details
-
ToolComponent
public ToolComponent()
-
-
Method Details
-
getGuid
A unique identifer for the tool component in the form of a GUID. -
setGuid
A unique identifer for the tool component in the form of a GUID. -
withGuid
-
getName
The name of the tool component. (Required) -
setName
The name of the tool component. (Required) -
withName
-
getOrganization
The organization or company that produced the tool component. -
setOrganization
The organization or company that produced the tool component. -
withOrganization
-
getProduct
A product suite to which the tool component belongs. -
setProduct
A product suite to which the tool component belongs. -
withProduct
-
getProductSuite
A localizable string containing the name of the suite of products to which the tool component belongs. -
setProductSuite
A localizable string containing the name of the suite of products to which the tool component belongs. -
withProductSuite
-
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
-
getFullName
The name of the tool component along with its version and any other useful identifying information, such as its locale. -
setFullName
The name of the tool component along with its version and any other useful identifying information, such as its locale. -
withFullName
-
getVersion
The tool component version, in whatever format the component natively provides. -
setVersion
The tool component version, in whatever format the component natively provides. -
withVersion
-
getSemanticVersion
The tool component version in the format specified by Semantic Versioning 2.0. -
setSemanticVersion
The tool component version in the format specified by Semantic Versioning 2.0. -
withSemanticVersion
-
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
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
-
getReleaseDateUtc
A string specifying the UTC date (and optionally, the time) of the component's release. -
setReleaseDateUtc
A string specifying the UTC date (and optionally, the time) of the component's release. -
withReleaseDateUtc
-
getDownloadUri
The absolute URI from which the tool component can be downloaded. -
setDownloadUri
The absolute URI from which the tool component can be downloaded. -
withDownloadUri
-
getInformationUri
The absolute URI at which information about this version of the tool component can be found. -
setInformationUri
The absolute URI at which information about this version of the tool component can be found. -
withInformationUri
-
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
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
-
getNotifications
An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component. -
setNotifications
An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component. -
withNotifications
-
getRules
An array of reportingDescriptor objects relevant to the analysis performed by the tool component. -
setRules
An array of reportingDescriptor objects relevant to the analysis performed by the tool component. -
withRules
-
getTaxa
An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies. -
setTaxa
An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies. -
withTaxa
-
getLocations
An array of the artifactLocation objects associated with the tool component. -
setLocations
An array of the artifactLocation objects associated with the tool component. -
withLocations
-
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
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
-
getContents
The kinds of data contained in this object. -
setContents
The kinds of data contained in this object. -
withContents
-
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
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
-
getLocalizedDataSemanticVersion
The semantic version of the localized strings defined in this component; maintained by components that provide translations. -
setLocalizedDataSemanticVersion
The semantic version of the localized strings defined in this component; maintained by components that provide translations. -
withLocalizedDataSemanticVersion
-
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
Identifies a particular toolComponent object, either the driver or an extension. -
setAssociatedComponent
Identifies a particular toolComponent object, either the driver or an extension. -
withAssociatedComponent
-
getTranslationMetadata
Provides additional metadata related to translation. -
setTranslationMetadata
Provides additional metadata related to translation. -
withTranslationMetadata
-
getSupportedTaxonomies
An array of toolComponentReference objects to declare the taxonomies supported by the tool component. -
setSupportedTaxonomies
An array of toolComponentReference objects to declare the taxonomies supported by the tool component. -
withSupportedTaxonomies
-
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
-