public class RootIssue
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
RootIssue.Level
Severity level of this issue.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
displayIssues(java.util.List issues,
boolean includeInfo)
Formats a string of issues for display.
|
static void |
displayIssues(java.util.List issues,
java.io.OutputStream ostream,
boolean includeInfo)
Displays a list of issue objects, to the specified output stream.
|
static java.lang.String |
displayIssues(java.util.List issues,
RootIssue.Level level)
Returns a string of issues formatted for display.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDescription()
Gets the description of this issue.
|
java.lang.Object |
getErrorObject()
Gets the object which generated the error, or null if there is none.
|
java.lang.Exception |
getException()
If the issue has an exception as a cause, return the exception, else return null.
|
RootIssue.Level |
getLevel()
Gets the severity level of this issue.
|
java.lang.String |
getMessage()
Returns the message of this issue, based on default locale
|
java.lang.String |
getMessage(java.util.Locale locale)
Returns the message of this issue, based on the specified locale
|
java.lang.String |
getMessageAction()
Returns the action of the message, which may specify a solution for the issue.
|
java.lang.String |
getMessageCause()
Returns the cause of the message, which may indicate conditions causing the issue.
|
java.lang.String |
getMessageID()
Returns the message ID of the message for this issue.
|
boolean |
isError()
Returns true if this issue has a severity of ERROR or FATAL
|
static boolean |
isErrorOrFatal(java.util.List issues)
Returns true is any of the given issues has a level of error or fatal
|
boolean |
isFatal()
Returns true if this issue has a severity of FATAL.
|
static boolean |
isFatal(java.util.List issues)
Returns true if any of the given issues have a severity level of fatal.
|
boolean |
isInfo()
Returns true if this issue has a severity of INFO
|
static boolean |
isUserMessage(java.util.List issues)
Returns true if all the error messages in the specified issue list
are user messages.
|
boolean |
isWarning()
Returns true if this issue has a severity of WARNING
|
void |
setLevel(RootIssue.Level level)
Sets the severity level of this issue.
|
java.lang.String |
toString()
Gets a string that neatly displays the issue level and description.
|
java.lang.String |
toString(boolean includeLevel)
Gets a string that neatly displays the issue level and description.
|
public RootIssue(RootIssue.Level level, java.lang.String messageKey)
level
- The severity level of this issue.messageKey
- The message key for the issue.public RootIssue(RootIssue.Level level, java.lang.Object errorObject, java.lang.String messageKey, java.lang.Object[] args)
level
- The severity level of this issue.errorObject
- The object which generated the error.messageKey
- The message key for the issue.args
- The message arguments for the issue.public RootIssue(java.lang.Exception ex)
ex
- The exception that caused the issue.public RootIssue(java.lang.Exception ex, java.lang.Object errorObject)
ex
- The exception that caused the issue.public RootIssue(java.lang.Exception ex, java.lang.Object errorObject, RootIssue.Level level)
ex
- The exception that caused the issue.errorObject
- The object which generated the error.level
- severity levelpublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public RootIssue.Level getLevel()
public void setLevel(RootIssue.Level level)
level
- The severity level to set.public java.lang.String getDescription()
public java.lang.String getMessage()
public java.lang.String getMessage(java.util.Locale locale)
locale
- The locale used for the translated messagepublic java.lang.Object getErrorObject()
public java.lang.String getMessageID()
public java.lang.String getMessageCause()
public java.lang.String getMessageAction()
public boolean isFatal()
public boolean isError()
public boolean isWarning()
public boolean isInfo()
public java.lang.Exception getException()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(boolean includeLevel)
includeLevel
- specifies whether the level should be prefixed to the message.public static java.lang.String displayIssues(java.util.List issues, boolean includeInfo)
issues
- The list of issues to be displayed.includeInfo
- If true, INFO level issues will be displayed, else only warning and higher levels are displayed..public static boolean isUserMessage(java.util.List issues)
issues
- issue list to checkpublic static java.lang.String displayIssues(java.util.List issues, RootIssue.Level level)
issues
- The list of issues to be displayed.level
- The severity level on which to filter the issues. Only issues with a severity at or higher
than this level will be displayed.public static void displayIssues(java.util.List issues, java.io.OutputStream ostream, boolean includeInfo)
issues
- The list of issues to be displayed.ostream
- The output stream where the issues list will be printed. If null, the issues will be
displayed in the mapping logger.includeInfo
- If true, the info-level issues are displayed.public static boolean isErrorOrFatal(java.util.List issues)
issues
- issue list to checkpublic static boolean isFatal(java.util.List issues)
issues
- issue list to check