com.contrastsecurity.sarif

Class Attachment

java.lang.Object

com.contrastsecurity.sarif.Attachment

public class Attachment
extends Object

An artifact relevant to a result.

Constructor Summary

Constructors

Constructor and Description
Attachment()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
ArtifactLocation	getArtifactLocation() Specifies the location of an artifact.
Message	getDescription() Encapsulates a message intended to be read by the end user.
PropertyBag	getProperties() Key/value pairs that provide additional information about the object.
Set<Rectangle>	getRectangles() An array of rectangles specifying areas of interest within the image.
Set<Region>	getRegions() An array of regions of interest within the attachment.
int	hashCode()
void	setArtifactLocation(ArtifactLocation artifactLocation) Specifies the location of an artifact.
void	setDescription(Message description) Encapsulates a message intended to be read by the end user.
void	setProperties(PropertyBag properties) Key/value pairs that provide additional information about the object.
void	setRectangles(Set<Rectangle> rectangles) An array of rectangles specifying areas of interest within the image.
void	setRegions(Set<Region> regions) An array of regions of interest within the attachment.
String	toString()
Attachment	withArtifactLocation(ArtifactLocation artifactLocation)
Attachment	withDescription(Message description)
Attachment	withProperties(PropertyBag properties)
Attachment	withRectangles(Set<Rectangle> rectangles)
Attachment	withRegions(Set<Region> regions)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Attachment

public Attachment()

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.

withDescription

public Attachment withDescription(Message description)

getArtifactLocation

public ArtifactLocation getArtifactLocation()

Specifies the location of an artifact. (Required)

setArtifactLocation

public void setArtifactLocation(ArtifactLocation artifactLocation)

Specifies the location of an artifact. (Required)

withArtifactLocation

public Attachment withArtifactLocation(ArtifactLocation artifactLocation)

getRegions

public Set<Region> getRegions()

An array of regions of interest within the attachment.

setRegions

public void setRegions(Set<Region> regions)

An array of regions of interest within the attachment.

withRegions

public Attachment withRegions(Set<Region> regions)

getRectangles

public Set<Rectangle> getRectangles()

An array of rectangles specifying areas of interest within the image.

setRectangles

public void setRectangles(Set<Rectangle> rectangles)

An array of rectangles specifying areas of interest within the image.

withRectangles

public Attachment withRectangles(Set<Rectangle> rectangles)

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 Attachment 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