Package com.mendix.systemwideinterfaces.core

Class UserException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.mendix.systemwideinterfaces.MendixRuntimeException

com.mendix.systemwideinterfaces.core.UserException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthenticationRuntimeException

public class UserException
extends MendixRuntimeException

Represents an exception for reporting messages to user. This exception doesn't provide a stacktrace, which makes its creation 10 times faster!

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserException.ExceptionCategory	Defines the available exception categories.

Constructor Summary

Constructors

Constructor	Description
UserException(DataValidationInfo dvInfo)	Create a new UserException (data validation).
UserException(UserException.ExceptionCategory category, String message)	Creates a new user exception with the specified message and category.
UserException(UserException.ExceptionCategory category, String message, Throwable cause)	Creates a new user exception with the specified message, cause and category.
UserException(UserException.ExceptionCategory category, Throwable cause)	Creates a new user exception with the specified cause and category.

Method Summary

Modifier and Type	Method	Description
Throwable	fillInStackTrace()	Prevents this exception from generating a stack trace.
UserException.ExceptionCategory	getCategory()	Returns the exception category.
DataValidationInfo	getDataValidationFeedback()	Returns data validation info, containing validation errors.
String	toString()	Returns ether the exception message, or data validation errors if they are present.

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UserException

public UserException(UserException.ExceptionCategory category,
 String message)

Creates a new user exception with the specified message and category.

Parameters:

category - the exception category

message - the exception message

UserException

public UserException(UserException.ExceptionCategory category,
 Throwable cause)

Creates a new user exception with the specified cause and category.

Parameters:

category - the exception category

cause - the exception that caused this exception

UserException

public UserException(UserException.ExceptionCategory category,
 String message,
 Throwable cause)

Creates a new user exception with the specified message, cause and category.

Parameters:

category - the exception category

message - the exception message

cause - the exception that caused this exception

UserException

public UserException(DataValidationInfo dvInfo)

Create a new UserException (data validation).

Parameters:

dvInfo - the data validation info

Method Details

getCategory

public UserException.ExceptionCategory getCategory()

Returns the exception category.

Returns:

the category

getDataValidationFeedback

public DataValidationInfo getDataValidationFeedback()

Returns data validation info, containing validation errors.

Returns:

the data validation info

fillInStackTrace

public Throwable fillInStackTrace()

Prevents this exception from generating a stack trace. Makes the creation of this exception 10 times faster!

Overrides:

fillInStackTrace in class Throwable

toString

public String toString()

Returns ether the exception message, or data validation errors if they are present.

Overrides:

toString in class Throwable

Returns:

data validation errors if they are present, or the exception message otherwise