@Internal public abstract class

AbstractMessageSet

extends Object
implements MessageSet
java.lang.Object
   ↳ com.atlassian.jira.util.AbstractMessageSet
Known Direct Subclasses

@Internal

This class is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

Base class for the message set.

Summary

Protected Constructors
AbstractMessageSet(Map<String, MessageSet.MessageLink> errors, Map<String, MessageSet.MessageLink> warnings, Set<String> errorsInEnglish, Set<String> warningsInEnglish)
Public Methods
void addErrorMessage(String errorMessage)
Adds an error message.
void addErrorMessage(String errorMessage, MessageSet.MessageLink link)
Adds an error message and associates a link with the error.
void addErrorMessageInEnglish(String errorMessage)
Adds an error message in English.
void addMessage(MessageSet.Level level, String errorMessage)
Adds a message with the given warning / error level
void addMessage(MessageSet.Level level, String errorMessage, MessageSet.MessageLink link)
Adds an error message with the given warning / error level and associates a link with the error.
void addMessageSet(MessageSet messageSet)
Will concatenate this message set with the provided message set.
void addWarningMessage(String warningMessage)
Adds a warning message.
void addWarningMessage(String warningMessage, MessageSet.MessageLink link)
Adds a warning message and associates a link with the warning.
void addWarningMessageInEnglish(String warningMessage)
Adds a warning message in English.
boolean equals(Object o)
Set<String> getErrorMessages()
Set<String> getErrorMessagesInEnglish()
Returns a unique set of all the English error messages.
MessageSet.MessageLink getLinkForError(String errorMsg)
MessageSet.MessageLink getLinkForWarning(String warningMsg)
Set<String> getWarningMessages()
Set<String> getWarningMessagesInEnglish()
Returns a unique set of all the English warning messages.
boolean hasAnyErrors()
Returns true if there are error messages, false otherwise.
boolean hasAnyMessages()
Returns true if there are messages of any type, false otherwise.
boolean hasAnyWarnings()
Returns true if there are warning messages, false otherwise.
int hashCode()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.util.MessageSet

Protected Constructors

protected AbstractMessageSet (Map<String, MessageSet.MessageLink> errors, Map<String, MessageSet.MessageLink> warnings, Set<String> errorsInEnglish, Set<String> warningsInEnglish)

Public Methods

public void addErrorMessage (String errorMessage)

Adds an error message.

Parameters
errorMessage the message to add.

public void addErrorMessage (String errorMessage, MessageSet.MessageLink link)

Adds an error message and associates a link with the error.

Parameters
errorMessage the message to add.
link the link to show the users associated with this error.

public void addErrorMessageInEnglish (String errorMessage)

Adds an error message in English.

This is useful when the addErrorMessage(String) method is used to add translated messages, and you want to be able to get a set of the messages in English as well. Eg, in the Project Import we show the translated messages on screen during validation, and log the English versions in case Atlassian Support needs to read the logs later.

Parameters
errorMessage the message to add.

public void addMessage (MessageSet.Level level, String errorMessage)

Adds a message with the given warning / error level

Parameters
level message level
errorMessage the message to add.

public void addMessage (MessageSet.Level level, String errorMessage, MessageSet.MessageLink link)

Adds an error message with the given warning / error level and associates a link with the error.

Parameters
level message level
errorMessage the message to add.
link the link to show the users associated with this error.

public void addMessageSet (MessageSet messageSet)

Will concatenate this message set with the provided message set. All new errors and warnings will be added to the existing errors and warnings.

Parameters
messageSet contains the new errors and warnings to add to this set.

public void addWarningMessage (String warningMessage)

Adds a warning message.

Parameters
warningMessage the message to add.

public void addWarningMessage (String warningMessage, MessageSet.MessageLink link)

Adds a warning message and associates a link with the warning.

Parameters
warningMessage the message to add.
link the link to show the users associated with this warning.

public void addWarningMessageInEnglish (String warningMessage)

Adds a warning message in English.

This is useful when the addWarningMessage(String) method is used to add translated messages, and you want to be able to get a set of the messages in English as well. Eg, in the Project Import we show the translated messages on screen during validation, and log the English versions in case Atlassian Support needs to read the logs later.

Parameters
warningMessage the message to add.

public boolean equals (Object o)

public Set<String> getErrorMessages ()

public Set<String> getErrorMessagesInEnglish ()

Returns a unique set of all the English error messages.

Returns
  • a unique set of all the English error messages.

public MessageSet.MessageLink getLinkForError (String errorMsg)

public MessageSet.MessageLink getLinkForWarning (String warningMsg)

public Set<String> getWarningMessages ()

public Set<String> getWarningMessagesInEnglish ()

Returns a unique set of all the English warning messages.

Returns
  • a unique set of all the English warning messages.

public boolean hasAnyErrors ()

Returns true if there are error messages, false otherwise.

Returns
  • true if there are error messages, false otherwise.

public boolean hasAnyMessages ()

Returns true if there are messages of any type, false otherwise. That is, it will return true if hasAnyErrors() is true or hasAnyWarnings() is true.

Returns
  • true if there are messages of any type, false otherwise.

public boolean hasAnyWarnings ()

Returns true if there are warning messages, false otherwise.

Returns
  • true if there are warning messages, false otherwise.

public int hashCode ()

public String toString ()