Package mc.core.system.util.exception

Class UserException

java.lang.Object

java.lang.Throwable

java.lang.Exception

mc.core.system.util.exception.ApplicationException

mc.core.system.util.exception.UserException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DeleteTiedElementException

public class UserException
extends ApplicationException

used to signal problems or backend activities to user (not necessarily errors). can have several localized and parametrized message for ui display or notification. Use method #getLocalizedMessage(String) to retrieve all messages concatenated.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserException.Severity

Constructor Summary

Constructors

Constructor	Description
UserException(Object... args)
UserException(String message, Object... args)
UserException(String message, Throwable cause, Object... args)
UserException(String message, UserException.Severity severity, Object... args)
UserException(Throwable cause, Object... args)

Method Summary

Modifier and Type	Method	Description
UserException	addMessageLine(String messageKey, Object... args)	add a line to message in order to display as one message with several lines using default linebreak String or custom by calling linebreak(String)
String	getLocalizedMessage(mc.core.system.util.labels.Labels labels, Locale locale)
List<mc.core.system.util.misc.Pair<String,Object[]>>	getMessageLines()
UserException.Severity	getSeverity()
boolean	hasSeveralLines()
UserException	linebreak(String linebreak)
UserException	setSeverity(UserException.Severity severity)

Methods inherited from class mc.core.system.util.exception.ApplicationException

getArgs, getMessage, log, shouldLog

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UserException

public UserException(Object... args)

UserException

public UserException(String message,
 Object... args)

UserException

public UserException(String message,
 UserException.Severity severity,
 Object... args)

UserException

public UserException(String message,
 Throwable cause,
 Object... args)

UserException

public UserException(Throwable cause,
 Object... args)

Method Details

getSeverity

public UserException.Severity getSeverity()

setSeverity

public UserException setSeverity(UserException.Severity severity)

addMessageLine

public UserException addMessageLine(String messageKey,
 Object... args)

add a line to message in order to display as one message with several lines using default linebreak String or custom by calling linebreak(String)

Parameters:

messageKey - the message key if message is to be converted using a different locale, mandatory

args - optional

linebreak

public UserException linebreak(String linebreak)

getLocalizedMessage

public String getLocalizedMessage(mc.core.system.util.labels.Labels labels,
 Locale locale)

Overrides:

getLocalizedMessage in class ApplicationException

hasSeveralLines

public boolean hasSeveralLines()

getMessageLines

public List<mc.core.system.util.misc.Pair<String,Object[]>> getMessageLines()