org.geomajas.global

Class GeomajasException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.geomajas.global.GeomajasException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GeomajasSecurityException, LayerException

@Api(allMethods=true)
public class GeomajasException
extends Exception

General exception thrown by Geomajas when problems occur. This allows specifying exception codes through which the (translated) exception message is found. The message can contain extra information which can be passed separately. The pattern "${0}" is replaced by the first extra string etc. You can also use the pattern "$${0}" which will attempt to translate the parameter as well.

Since:

1.6.0

Author:

Joachim Van der Auwera

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeomajasException() Create new GeomajasException.
GeomajasException(int exceptionCode) Create new GeomajasException.
GeomajasException(int exceptionCode, Object... parameters) Create new GeomajasException.
GeomajasException(Throwable ex) Create new GeomajasException.
GeomajasException(Throwable ex, int exceptionCode) Create new GeomajasException.
GeomajasException(Throwable ex, int exceptionCode, Object... parameters) Create new GeomajasException.

Method Summary

Methods

Modifier and Type	Method and Description
int	getExceptionCode() Get the exception code for the problem.
String	getMessage() Get message using the default locale.
String	getMessage(Locale locale) Get the exception message using the requested locale.
String	getResourceBundleName() Resource bundle to be used for translating the exception code into exception messages.
String	getShortMessage(Locale locale) Get the short exception message using the requested locale.

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 Detail

GeomajasException

public GeomajasException()

Create new GeomajasException.

GeomajasException

public GeomajasException(Throwable ex)

Create new GeomajasException.

Parameters:

ex - cause exception

GeomajasException

public GeomajasException(Throwable ex,
                 int exceptionCode,
                 Object... parameters)

Create new GeomajasException.

Parameters:

ex - cause exception

exceptionCode - code which points to the message

parameters - possible extra parameters

GeomajasException

public GeomajasException(Throwable ex,
                 int exceptionCode)

Create new GeomajasException.

Parameters:

ex - cause exception

exceptionCode - code which points to the message

GeomajasException

public GeomajasException(int exceptionCode,
                 Object... parameters)

Create new GeomajasException.

Parameters:

exceptionCode - code which points to the message

parameters - possible extra parameters

GeomajasException

public GeomajasException(int exceptionCode)

Create new GeomajasException.

Parameters:

exceptionCode - code which points to the message

Method Detail

getMessage

public String getMessage()

Get message using the default locale.

Overrides:

getMessage in class Throwable

Returns:

exception message

getMessage

public String getMessage(Locale locale)

Get the exception message using the requested locale.

Parameters:

locale - locale for message

Returns:

exception message

getShortMessage

public String getShortMessage(Locale locale)

Get the short exception message using the requested locale. This does not include the cause exception message.

Parameters:

locale - locale for message

Returns:

(short) exception message

getExceptionCode

public int getExceptionCode()

Get the exception code for the problem.

Returns:

exception code

getResourceBundleName

public String getResourceBundleName()

Resource bundle to be used for translating the exception code into exception messages.

Returns:

resource bundle name