net.sf.layoutParser.exception

Class BaseLocalizedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.sf.layoutParser.exception.BaseLocalizedException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BuilderException, LayoutException

public abstract class BaseLocalizedException
extends Exception

This is the base exception for all concrete exceptions implemented in the framework.
It provides a mean to throw localized exceptions based on properties files on the system. These files
should begin with "ExceptionsBundle" name followed by their country code name. i.e.:

For Deutch the file should be named: ExceptionsBundle_de.properties
For Portugues the file should be named: ExceptionsBundle_pt.properties

This is defined by the constant ExceptionKey.BUNDLE_NAME. Each key on the message file should be parameterized in the enumeration ExceptionKey,
otherwise it wont throw the message correctly.

Since:

1.0

Author:

Mário Valentim Junior

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseLocalizedException()
BaseLocalizedException(ExceptionKey key) Create's a new exception with the message that matches the key in the bundle exception file.
BaseLocalizedException(ExceptionKey key, Object[] parameters) Create's a new exception with the message that matches the key in the bundle exception file.
BaseLocalizedException(ExceptionKey key, Object[] parameters, Throwable cause) Create's a new exception with the message that matches the key in the bundle exception file.
BaseLocalizedException(ExceptionKey key, Throwable cause) Create's a new exception with the message that matches the key in the bundle exception file.
BaseLocalizedException(Throwable cause) Create a new base exception that encapsulates a root exception.

Method Summary

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseLocalizedException

public BaseLocalizedException()

See Also:

Exception.Exception()

BaseLocalizedException

public BaseLocalizedException(ExceptionKey key)

Create's a new exception with the message that matches the key in the bundle exception file. This should be thrown when the message doesn't have parameters in it.

Parameters:

key - The key of the message on the properties file

See Also:

Exception.Exception(String)

BaseLocalizedException

public BaseLocalizedException(ExceptionKey key,
                      Object[] parameters)

Create's a new exception with the message that matches the key in the bundle exception file. This should be thrown when the message have parameters in it.

Parameters:

key - The key of the message on the properties file

parameters - The parameters of the message

See Also:

Exception.Exception(String)

BaseLocalizedException

public BaseLocalizedException(ExceptionKey key,
                      Object[] parameters,
                      Throwable cause)

Create's a new exception with the message that matches the key in the bundle exception file.
This should be thrown when the message have parameters in it and there's a root exception that caused this message.

Parameters:

key - The key of the message on the properties file

parameters - The parameters of the message

cause - The root cause of the exception

See Also:

Exception.Exception(String, Throwable)

BaseLocalizedException

public BaseLocalizedException(ExceptionKey key,
                      Throwable cause)

Create's a new exception with the message that matches the key in the bundle exception file.
This should be thrown when the message doesn't have parameters in it and there's a root exception that caused this message.

Parameters:

key -

cause -

See Also:

Exception.Exception(String, Throwable)

BaseLocalizedException

public BaseLocalizedException(Throwable cause)

Create a new base exception that encapsulates a root exception.

Parameters:

cause - The root cause of the exception

See Also:

Exception.Exception(Throwable)