org.geomajas.global

Class ExceptionDto

java.lang.Object

org.geomajas.global.ExceptionDto

All Implemented Interfaces:

Serializable

@Api(allMethods=true)
public class ExceptionDto
extends Object
implements Serializable

A Data Transfer Object (DTO) that is used when exceptions that occurred on the server need to be send back to the client. Instead of send general exceptions we take the safe route and this type of object instead.

Since:

1.8.0

Author:

Pieter De Graef

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExceptionDto() Empty constructor for serialization purposes.
ExceptionDto(String className, String message, StackTraceElement[] stackTrace) Constructor that takes all needed information on creation.

Method Summary

Methods

Modifier and Type	Method and Description
ExceptionDto	getCause() Set the cause exception to allow inclusion in the display.
String	getClassName() Returns the class name of the original exception.
int	getExceptionCode() Get the exception code (when it is a GeomajasException).
String	getMessage() Returns the message of the original exception.
StackTraceElement[]	getStackTrace() Returns the stack trace of the original exception.
void	setCause(ExceptionDto cause) Get the cause exception to allow inclusion in the error display.
void	setClassName(String className) Set the class name of the original exception.
void	setExceptionCode(int exceptionCode) Set the exception code (when it is a GeomajasException.
void	setMessage(String message) Set the message of the original exception.
void	setStackTrace(StackTraceElement[] stackTrace) Set the stack trace of the original exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionDto

public ExceptionDto()

Empty constructor for serialization purposes.

ExceptionDto

public ExceptionDto(String className,
            String message,
            StackTraceElement[] stackTrace)

Constructor that takes all needed information on creation.

Parameters:

className - The class name of the original exception.

message - The exception message.

stackTrace - The full stack trace.

Method Detail

getClassName

public String getClassName()

Returns the class name of the original exception.

Returns:

The real exceptions class name.

setClassName

public void setClassName(String className)

Set the class name of the original exception.

Parameters:

className - The exception class name.

getMessage

public String getMessage()

Returns the message of the original exception.

Returns:

The real exceptions message.

setMessage

public void setMessage(String message)

Set the message of the original exception.

Parameters:

message - The exception message.

getStackTrace

public StackTraceElement[] getStackTrace()

Returns the stack trace of the original exception.

Returns:

The real exceptions stack trace.

setStackTrace

public void setStackTrace(StackTraceElement[] stackTrace)

Set the stack trace of the original exception.

Parameters:

stackTrace - The exception stack trace.

getCause

public ExceptionDto getCause()

Set the cause exception to allow inclusion in the display.

Returns:

cause exception DTO

Since:

1.10.0

setCause

public void setCause(ExceptionDto cause)

Get the cause exception to allow inclusion in the error display.

Parameters:

cause - cause exception DTO

Since:

1.10.0

getExceptionCode

public int getExceptionCode()

Get the exception code (when it is a GeomajasException).

Returns:

GeomajasException exception code

Since:

1.10.0

setExceptionCode

public void setExceptionCode(int exceptionCode)

Set the exception code (when it is a GeomajasException.

Parameters:

exceptionCode - GeomajasException exception code

Since:

1.10.0