Package com.atlassian.jira.util
Interface MessageSet
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractMessageSet
,ListOrderedMessageSetImpl
,MessageSetImpl
Used to communicate error and warning messages.
- Since:
- v3.13
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
Message levelsstatic class
A simple class for holding link text and a link url. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 levelvoid
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.Returns a unique set of all the English error messages.getLinkForError
(String errorMsg) getLinkForWarning
(String warningMsg) Returns a unique set of all the English warning messages.boolean
Returnstrue
if there are error messages,false
otherwise.boolean
Returnstrue
if there are messages of any type,false
otherwise.boolean
Returnstrue
if there are warning messages,false
otherwise.
-
Method Details
-
getErrorMessages
- Returns:
- a unique set of error messages, these messages are separate from the warning messages, never null.
-
getLinkForError
- Parameters:
errorMsg
- the unique error message- Returns:
- the MessageLink that is associated with the error, if one exists, null otherwise.
-
getErrorMessagesInEnglish
Returns a unique set of all the English error messages.- Returns:
- a unique set of all the English error messages.
- See Also:
-
getWarningMessages
- Returns:
- a unique set of warning messages, these messages are separate from the error messages, never null.
-
getLinkForWarning
- Parameters:
warningMsg
- the unique warning message- Returns:
- the MessageLink that is associated with the warning, if one exists, null otherwise.
-
getWarningMessagesInEnglish
Returns a unique set of all the English warning messages.- Returns:
- a unique set of all the English warning messages.
- See Also:
-
hasAnyErrors
boolean hasAnyErrors()Returnstrue
if there are error messages,false
otherwise.- Returns:
true
if there are error messages,false
otherwise.
-
hasAnyWarnings
boolean hasAnyWarnings()Returnstrue
if there are warning messages,false
otherwise.- Returns:
true
if there are warning messages,false
otherwise.
-
hasAnyMessages
boolean hasAnyMessages()Returnstrue
if there are messages of any type,false
otherwise. That is, it will return true if hasAnyErrors() istrue
or hasAnyWarnings() istrue
.- Returns:
true
if there are messages of any type,false
otherwise.
-
addMessageSet
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.
-
addMessage
Adds a message with the given warning / error level- Parameters:
level
- message levelerrorMessage
- the message to add.
-
addMessage
Adds an error message with the given warning / error level and associates a link with the error.- Parameters:
level
- message levelerrorMessage
- the message to add.link
- the link to show the users associated with this error.
-
addErrorMessage
Adds an error message.- Parameters:
errorMessage
- the message to add.
-
addErrorMessage
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.
-
addErrorMessageInEnglish
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.- See Also:
-
addWarningMessage
Adds a warning message.- Parameters:
warningMessage
- the message to add.
-
addWarningMessage
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.
-
addWarningMessageInEnglish
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.- See Also:
-