ToolComponent

A component, such as a plug-in or the driver, of the analysis tool that was run.

Constructors

Link copied to clipboard
constructor()
No args constructor for use in serialization
constructor(name: String)

Properties

Link copied to clipboard
@SerializedName(value = "associatedComponent")
@Expose
open var associatedComponent: ToolComponentReference
Identifies a particular toolComponent object, either the driver or an extension.
Link copied to clipboard
@SerializedName(value = "contents")
@Expose
open var contents: Set<Content>
The kinds of data contained in this object.
Link copied to clipboard
@SerializedName(value = "dottedQuadFileVersion")
@Expose
open var dottedQuadFileVersion: String
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).
Link copied to clipboard
@SerializedName(value = "downloadUri")
@Expose
open var downloadUri: URI
The absolute URI from which the tool component can be downloaded.
Link copied to clipboard
@SerializedName(value = "fullDescription")
@Expose
open var fullDescription: MultiformatMessageString
A message string or message format string rendered in multiple formats.
Link copied to clipboard
@SerializedName(value = "fullName")
@Expose
open var fullName: String
The name of the tool component along with its version and any other useful identifying information, such as its locale.
Link copied to clipboard
@SerializedName(value = "globalMessageStrings")
@Expose
open var 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.
Link copied to clipboard
@SerializedName(value = "guid")
@Expose
open var guid: String
A unique identifer for the tool component in the form of a GUID.
Link copied to clipboard
@SerializedName(value = "informationUri")
@Expose
open var informationUri: URI
The absolute URI at which information about this version of the tool component can be found.
Link copied to clipboard
@SerializedName(value = "isComprehensive")
@Expose
open var isComprehensive: Boolean
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.
Link copied to clipboard
@SerializedName(value = "language")
@Expose
open var language: String
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).
Link copied to clipboard
@SerializedName(value = "localizedDataSemanticVersion")
@Expose
open var localizedDataSemanticVersion: String
The semantic version of the localized strings defined in this component; maintained by components that provide translations.
Link copied to clipboard
@SerializedName(value = "locations")
@Expose
open var locations: List<ArtifactLocation>
An array of the artifactLocation objects associated with the tool component.
@SerializedName(value = "minimumRequiredLocalizedDataSemanticVersion")
@Expose
open var minimumRequiredLocalizedDataSemanticVersion: String
The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
Link copied to clipboard
@SerializedName(value = "name")
@Expose
open var name: String
The name of the tool component.
Link copied to clipboard
@SerializedName(value = "notifications")
@Expose
open var notifications: List<ReportingDescriptor>
An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
Link copied to clipboard
@SerializedName(value = "organization")
@Expose
open var organization: String
The organization or company that produced the tool component.
Link copied to clipboard
@SerializedName(value = "product")
@Expose
open var product: String
A product suite to which the tool component belongs.
Link copied to clipboard
@SerializedName(value = "productSuite")
@Expose
open var productSuite: String
A localizable string containing the name of the suite of products to which the tool component belongs.
Link copied to clipboard
@SerializedName(value = "properties")
@Expose
open var properties: PropertyBag
Key/value pairs that provide additional information about the object.
Link copied to clipboard
@SerializedName(value = "releaseDateUtc")
@Expose
open var releaseDateUtc: String
A string specifying the UTC date (and optionally, the time) of the component's release.
Link copied to clipboard
@SerializedName(value = "rules")
@Expose
open var rules: List<ReportingDescriptor>
An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
Link copied to clipboard
@SerializedName(value = "semanticVersion")
@Expose
open var semanticVersion: String
The tool component version in the format specified by Semantic Versioning 2.0.
Link copied to clipboard
@SerializedName(value = "shortDescription")
@Expose
open var shortDescription: MultiformatMessageString
A message string or message format string rendered in multiple formats.
Link copied to clipboard
@SerializedName(value = "supportedTaxonomies")
@Expose
open var supportedTaxonomies: Set<ToolComponentReference>
An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
Link copied to clipboard
@SerializedName(value = "taxa")
@Expose
open var taxa: List<ReportingDescriptor>
An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
Link copied to clipboard
@SerializedName(value = "translationMetadata")
@Expose
open var translationMetadata: TranslationMetadata
Provides additional metadata related to translation.
Link copied to clipboard
@SerializedName(value = "version")
@Expose
open var version: String
The tool component version, in whatever format the component natively provides.

Functions

Link copied to clipboard
open fun equals(other: Any): Boolean
Link copied to clipboard
abstract fun getProperties(): PropertyBag
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
abstract fun setProperties(<set-?>: PropertyBag)
Link copied to clipboard
Link copied to clipboard
open fun toString(): String
Link copied to clipboard
open fun updateProperties(mutator: (in PropertyBag) -> Unit)
Link copied to clipboard
Link copied to clipboard
open fun withContents(contents: Set<Content>): ToolComponent
Link copied to clipboard
open fun withDottedQuadFileVersion(dottedQuadFileVersion: String): ToolComponent
Link copied to clipboard
open fun withDownloadUri(downloadUri: URI): ToolComponent
Link copied to clipboard
Link copied to clipboard
open fun withFullName(fullName: String): ToolComponent
Link copied to clipboard
Link copied to clipboard
open fun withGuid(guid: String): ToolComponent
Link copied to clipboard
open fun withInformationUri(informationUri: URI): ToolComponent
Link copied to clipboard
open fun withIsComprehensive(isComprehensive: Boolean): ToolComponent
Link copied to clipboard
open fun withLanguage(language: String): ToolComponent
Link copied to clipboard
open fun withLocalizedDataSemanticVersion(localizedDataSemanticVersion: String): ToolComponent
Link copied to clipboard
open fun withMinimumRequiredLocalizedDataSemanticVersion(minimumRequiredLocalizedDataSemanticVersion: String): ToolComponent
Link copied to clipboard
open fun withName(name: String): ToolComponent
Link copied to clipboard
Link copied to clipboard
open fun withOrganization(organization: String): ToolComponent
Link copied to clipboard
open fun withProduct(product: String): ToolComponent
Link copied to clipboard
open fun withProductSuite(productSuite: String): ToolComponent
Link copied to clipboard
Link copied to clipboard
open fun withReleaseDateUtc(releaseDateUtc: String): ToolComponent
Link copied to clipboard
Link copied to clipboard
open fun withSemanticVersion(semanticVersion: String): ToolComponent
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun withVersion(version: String): ToolComponent