org.josef.util

Class AbstractLocalizedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.josef.util.AbstractLocalizedException

All Implemented Interfaces:

Serializable, Localizable

Direct Known Subclasses:

InvalidArgumentException

@Status(stage=PRODUCTION,
        unitTests=PARTIAL)
 @ThreadSafety(level=IMMUTABLE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public abstract class AbstractLocalizedException
extends Exception
implements Localizable

Ultimate base class for checked exceptions that are capable of showing localized messages.
Extend this class to add localizable messages to your own exceptions.
Note: This class is a copy of AbstractLocalizedRuntimeException except that this class extends Exception.

Version:

2.0 $Revision: 6488 $

Author:

Kees Schotanus, Martijn Baels

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractLocalizedException() Default constructor that creates an empty exception (that is an exception without a message and without a cause).
AbstractLocalizedException(String message) Constructs an exception using the supplied message.
AbstractLocalizedException(String resourceBundleName, String messageKey, Object... messageArguments) Constructs a localized exception from the supplied ResourceBundle name and the supplied message key and optional arguments.
AbstractLocalizedException(Throwable cause, String message) Constructs an exception using the supplied cause and message.
AbstractLocalizedException(Throwable cause, String resourceBundleName, String messageKey, Object... messageArguments) Constructs a localized exception from the supplied ResourceBundle name, the supplied message key, optional arguments and optional cause.

Method Summary

Modifier and Type	Method and Description
String	getDescription(Locale locale) Gets the (localized) message for the supplied locale.
String	getMessage() Gets the (localized) message for the default locale.
String	getMessage(Locale locale) Gets the (localized) message for the supplied locale.
Object[]	getMessageArguments() Gets a copy of the message arguments.
String	getMessageKey() Gets the key to the resource bundle to retrieve a localized message.
String	getResourceBundleName() Gets the resource bundle name containing the localized messages.
String	toString() Converts this exception to a String.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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 Detail

AbstractLocalizedException

public AbstractLocalizedException()

Default constructor that creates an empty exception (that is an exception without a message and without a cause).

AbstractLocalizedException

public AbstractLocalizedException(String message)

Constructs an exception using the supplied message.
The message may be localized but in this case it is up to the programmer to supply the correct localized message.

Parameters:

message - Message indicating why the exception occurred.

AbstractLocalizedException

public AbstractLocalizedException(Throwable cause,
                                  String message)

Constructs an exception using the supplied cause and message.
The message may be localized but in this case it is up to the programmer to supply the correct localized message.

Parameters:

cause - Exception that caused this exception.
May be null in which case this exception is not caused by another exception.

message - Message indicating why the exception occurred.

AbstractLocalizedException

public AbstractLocalizedException(String resourceBundleName,
                                  String messageKey,
                                  Object... messageArguments)

Constructs a localized exception from the supplied ResourceBundle name and the supplied message key and optional arguments.
Use this constructor when your message contains one or more message arguments.

Parameters:

resourceBundleName - The name of the ResourceBundle that contains the localized messages.

messageKey - Key to the resource bundle to retrieve the localized message.

messageArguments - The optional message arguments that will be inserted into the localized message.

Throws:

IllegalArgumentException - When the supplied resourceBundleName or messageKey is empty.

NullPointerException - When the supplied resourceBundleName or messageKey is null.

AbstractLocalizedException

public AbstractLocalizedException(Throwable cause,
                                  String resourceBundleName,
                                  String messageKey,
                                  Object... messageArguments)

Constructs a localized exception from the supplied ResourceBundle name, the supplied message key, optional arguments and optional cause.
Use this constructor when your message contains one or more message arguments or when this exception is caused by another exception.

Parameters:

cause - Exception that caused this exception.
May be null in which case this exception is not caused by another exception.

resourceBundleName - The name of the ResourceBundle that contains the localized messages.

messageKey - Key to the resource bundle to retrieve the localized message.

messageArguments - The message arguments that will be inserted into the localized message.

Throws:

IllegalArgumentException - When the supplied resourceBundleName or messageKey is empty.

NullPointerException - When the supplied resourceBundleName or messageKey is null.

Method Detail

getResourceBundleName

public String getResourceBundleName()

Gets the resource bundle name containing the localized messages.

Returns:

Resource bundle name containing the localized messages or null when no resource bundle has been supplied at construction time.

getMessageKey

public String getMessageKey()

Gets the key to the resource bundle to retrieve a localized message.

Returns:

The key to the resource bundle to retrieve a localized message.

getMessageArguments

public Object[] getMessageArguments()

Gets a copy of the message arguments.

Returns:

The message arguments.
Null is returned when this exception was created without a resource bundle name.

getMessage

public String getMessage()

Gets the (localized) message for the default locale.

Overrides:

getMessage in class Throwable

Returns:

The (localized) message for the default locale.

getMessage

public String getMessage(Locale locale)

Gets the (localized) message for the supplied locale.

Parameters:

locale - The locale.
When null, the default locale is used.

Returns:

The (localized) message for the supplied locale.
When this exception has been created with an actual message, this message is simply returned. When this exception was created with a resource bundle name, message key and optional arguments, a localized message is returned. This method will never throw a MissingResourceException.

getDescription

public String getDescription(Locale locale)

Gets the (localized) message for the supplied locale.
This message is completely similar to getMessage(Locale) but is needed to implement Localizable.

Specified by:

getDescription in interface Localizable

Parameters:

locale - The locale.
When null, the default locale is used.

Returns:

The (localized) message for the supplied locale.
When this exception has been created with an actual message, this message is simply returned. When this exception

See Also:

getMessage(Locale)

toString

public String toString()

Converts this exception to a String.

Overrides:

toString in class Throwable

Returns:

String representation of this exception.