com.contrastsecurity.sarif

Class Message

java.lang.Object

com.contrastsecurity.sarif.Message

public class Message
extends Object

Encapsulates a message intended to be read by the end user.

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
List<String>	getArguments() An array of strings to substitute into the message string.
String	getId() The identifier for this message.
String	getMarkdown() A Markdown message string.
PropertyBag	getProperties() Key/value pairs that provide additional information about the object.
String	getText() A plain text message string.
int	hashCode()
void	setArguments(List<String> arguments) An array of strings to substitute into the message string.
void	setId(String id) The identifier for this message.
void	setMarkdown(String markdown) A Markdown message string.
void	setProperties(PropertyBag properties) Key/value pairs that provide additional information about the object.
void	setText(String text) A plain text message string.
String	toString()
Message	withArguments(List<String> arguments)
Message	withId(String id)
Message	withMarkdown(String markdown)
Message	withProperties(PropertyBag properties)
Message	withText(String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Method Detail

getText

public String getText()

A plain text message string.

setText

public void setText(String text)

A plain text message string.

withText

public Message withText(String text)

getMarkdown

public String getMarkdown()

A Markdown message string.

setMarkdown

public void setMarkdown(String markdown)

A Markdown message string.

withMarkdown

public Message withMarkdown(String markdown)

getId

public String getId()

The identifier for this message.

setId

public void setId(String id)

The identifier for this message.

withId

public Message withId(String id)

getArguments

public List<String> getArguments()

An array of strings to substitute into the message string.

setArguments

public void setArguments(List<String> arguments)

An array of strings to substitute into the message string.

withArguments

public Message withArguments(List<String> arguments)

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