Artifact (sarif-2.1.0 1.1.0 API)

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

```
public class Artifact
extends java.lang.Object
```
A single artifact. In some cases, this artifact might be nested within another artifact.

Constructor Summary

Constructors
Constructor and Description

Artifact()

Constructors
Constructor and Description
`Artifact()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`ArtifactContent`	`getContents()` Represents the contents of an artifact.
`Message`	`getDescription()` Encapsulates a message intended to be read by the end user.
`java.lang.String`	`getEncoding()` Specifies the encoding for an artifact object that refers to a text file.
`Hashes`	`getHashes()` A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.
`java.util.Date`	`getLastModifiedTimeUtc()` The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified.
`java.lang.Integer`	`getLength()` The length of the artifact in bytes.
`ArtifactLocation`	`getLocation()` Specifies the location of an artifact.
`java.lang.String`	`getMimeType()` The MIME type (RFC 2045) of the artifact.
`java.lang.Integer`	`getOffset()` The offset in bytes of the artifact within its containing artifact.
`java.lang.Integer`	`getParentIndex()` Identifies the index of the immediate parent of the artifact, if this artifact is nested.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`java.util.Set<Role>`	`getRoles()` The role or roles played by the artifact in the analysis.
`java.lang.String`	`getSourceLanguage()` Specifies the source language for any artifact object that refers to a text file that contains source code.
`int`	`hashCode()`
`void`	`setContents(ArtifactContent contents)` Represents the contents of an artifact.
`void`	`setDescription(Message description)` Encapsulates a message intended to be read by the end user.
`void`	`setEncoding(java.lang.String encoding)` Specifies the encoding for an artifact object that refers to a text file.
`void`	`setHashes(Hashes hashes)` A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.
`void`	`setLastModifiedTimeUtc(java.util.Date lastModifiedTimeUtc)` The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified.
`void`	`setLength(java.lang.Integer length)` The length of the artifact in bytes.
`void`	`setLocation(ArtifactLocation location)` Specifies the location of an artifact.
`void`	`setMimeType(java.lang.String mimeType)` The MIME type (RFC 2045) of the artifact.
`void`	`setOffset(java.lang.Integer offset)` The offset in bytes of the artifact within its containing artifact.
`void`	`setParentIndex(java.lang.Integer parentIndex)` Identifies the index of the immediate parent of the artifact, if this artifact is nested.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setRoles(java.util.Set<Role> roles)` The role or roles played by the artifact in the analysis.
`void`	`setSourceLanguage(java.lang.String sourceLanguage)` Specifies the source language for any artifact object that refers to a text file that contains source code.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Artifact
```
public Artifact()
```
- Method Detail
  - getDescription
```
public Message getDescription()
```
    Encapsulates a message intended to be read by the end user.
  - setDescription
```
public void setDescription(Message description)
```
    Encapsulates a message intended to be read by the end user.
  - getLocation
```
public ArtifactLocation getLocation()
```
    Specifies the location of an artifact.
  - setLocation
```
public void setLocation(ArtifactLocation location)
```
    Specifies the location of an artifact.
  - getParentIndex
```
public java.lang.Integer getParentIndex()
```
    Identifies the index of the immediate parent of the artifact, if this artifact is nested.
  - setParentIndex
```
public void setParentIndex(java.lang.Integer parentIndex)
```
    Identifies the index of the immediate parent of the artifact, if this artifact is nested.
  - getOffset
```
public java.lang.Integer getOffset()
```
    The offset in bytes of the artifact within its containing artifact.
  - setOffset
```
public void setOffset(java.lang.Integer offset)
```
    The offset in bytes of the artifact within its containing artifact.
  - getLength
```
public java.lang.Integer getLength()
```
    The length of the artifact in bytes.
  - setLength
```
public void setLength(java.lang.Integer length)
```
    The length of the artifact in bytes.
  - getRoles
```
public java.util.Set<Role> getRoles()
```
    The role or roles played by the artifact in the analysis.
  - setRoles
```
public void setRoles(java.util.Set<Role> roles)
```
    The role or roles played by the artifact in the analysis.
  - getMimeType
```
public java.lang.String getMimeType()
```
    The MIME type (RFC 2045) of the artifact.
  - setMimeType
```
public void setMimeType(java.lang.String mimeType)
```
    The MIME type (RFC 2045) of the artifact.
  - getContents
```
public ArtifactContent getContents()
```
    Represents the contents of an artifact.
  - setContents
```
public void setContents(ArtifactContent contents)
```
    Represents the contents of an artifact.
  - getEncoding
```
public java.lang.String getEncoding()
```
    Specifies the encoding for an artifact object that refers to a text file.
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    Specifies the encoding for an artifact object that refers to a text file.
  - getSourceLanguage
```
public java.lang.String getSourceLanguage()
```
    Specifies the source language for any artifact object that refers to a text file that contains source code.
  - setSourceLanguage
```
public void setSourceLanguage(java.lang.String sourceLanguage)
```
    Specifies the source language for any artifact object that refers to a text file that contains source code.
  - getHashes
```
public Hashes getHashes()
```
    A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.
  - setHashes
```
public void setHashes(Hashes hashes)
```
    A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.
  - getLastModifiedTimeUtc
```
public java.util.Date getLastModifiedTimeUtc()
```
    The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.
  - setLastModifiedTimeUtc
```
public void setLastModifiedTimeUtc(java.util.Date lastModifiedTimeUtc)
```
    The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.
  - 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 Artifact

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Artifact

Method Detail

getDescription

setDescription

getLocation

setLocation

getParentIndex

setParentIndex

getOffset

setOffset

getLength

setLength

getRoles

setRoles

getMimeType

setMimeType

getContents

setContents

getEncoding

setEncoding

getSourceLanguage

setSourceLanguage

getHashes

setHashes

getLastModifiedTimeUtc

setLastModifiedTimeUtc

getProperties

setProperties

toString

hashCode

equals