de.smartics.exceptions.i18n
Class AbstractLocalizedRuntimeException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              de.smartics.exceptions.AbstractCoreRuntimeException
                  de.smartics.exceptions.i18n.AbstractLocalizedRuntimeException

All Implemented Interfaces:

CoreException, LocalizedException, Serializable

Direct Known Subclasses:

ConfigurationException, ParseException

public abstract class AbstractLocalizedRuntimeException
     
     

      
      extends 
      
      AbstractCoreRuntimeException
     
     
     
     

      
      implements 
      
      LocalizedException
     
     

The base implementation of exceptions that support internationalization for unchecked exceptions.

See Also:

Serialized Form

Field Summary

protected LocalizedInfo

localizedInfo The localized information controls the localization information.

Fields inherited from class de.smartics.exceptions.AbstractCoreRuntimeException

info

Constructor Summary

protected	AbstractLocalizedRuntimeException(Code code) Constructor.
protected	AbstractLocalizedRuntimeException(Code code, String bundleBaseName) Constructor.
protected	AbstractLocalizedRuntimeException(Throwable cause, Code code) Constructor.
protected	AbstractLocalizedRuntimeException(Throwable cause, Code code, String bundleBaseName) Constructor.
protected	AbstractLocalizedRuntimeException(Throwable cause, Code code, String bundleBaseName, String resourceKey) Constructor.

Method Summary

Messages	createMessages() Returns a created messages instance.
Messages	createMessages(Locale locale) Returns a created messages instance.
String	getBundleBaseName() Returns the fully qualified base name of the bundle to use.
CauseTrailMessages	getCauseTrail() Returns the cause trail of messages.
CauseTrailMessages	getCauseTrail(Locale locale) Returns the cause trail of messages.
String	getLocalizedMessage() Returns the localized message according to the system's default locale.
String	getLocalizedMessage(Locale locale) Returns the localized message for the given locale.
String	getLocalizedMessage(Locale locale, ClassLoader loader) Returns the localized message for the given locale.
String	getLocalizedMessage(String keyPrefix, Locale locale, MessageType messageType, ClassLoader loader) Returns the localized message for the given locale.
String	getMessage() Returns the detail message string of this throwable.
String	getMessage(Locale locale, MessageType messageType) Returns the message for the given message type.
String	getMessage(MessageType messageType) Returns the message for the given message type and the system's default locale.
String	getMessages() Returns the messages in one string.
String	getMessages(Locale locale) Returns the messages in one string.
String	getResourceKey() Returns the localization key to fetch messages from message bundles.
String	toString() Returns the string representation of the exception.

Methods inherited from class de.smartics.exceptions.AbstractCoreRuntimeException

getCause, getCode, getId, getTime, truncateCause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.smartics.exceptions.CoreException

getCause, getCode, getId, getStackTrace, getTime, setStackTrace, truncateCause

Field Detail

localizedInfo

protected final LocalizedInfo localizedInfo

The localized information controls the localization information.

Constructor Detail

AbstractLocalizedRuntimeException

protected AbstractLocalizedRuntimeException(Code code)

Constructor.

Parameters:

code - the error or exception code of the exception.

See Also:

AbstractLocalizedRuntimeException(Throwable,Code)

AbstractLocalizedRuntimeException

protected AbstractLocalizedRuntimeException(Code code,
                                            String bundleBaseName)

Constructor.

Parameters:

code - the error or exception code of the exception.

bundleBaseName - the fully qualified name of the bundle to use.

See Also:

AbstractLocalizedRuntimeException(Throwable,Code,String)

AbstractLocalizedRuntimeException

protected AbstractLocalizedRuntimeException(Throwable cause,
                                            Code code)

Constructor.

Parameters:

cause - the cause (which is saved for later retrieval by the AbstractCoreRuntimeException.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

code - the error or exception code of the exception.

See Also:

AbstractLocalizedRuntimeException(Throwable,Code,String)

AbstractLocalizedRuntimeException

protected AbstractLocalizedRuntimeException(Throwable cause,
                                            Code code,
                                            String bundleBaseName)

Constructor.

Parameters:

cause - the cause (which is saved for later retrieval by the AbstractCoreRuntimeException.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

code - the error or exception code of the exception.

bundleBaseName - the fully qualified name of the bundle to use.

See Also:

AbstractLocalizedRuntimeException(Throwable,Code,String,String)

AbstractLocalizedRuntimeException

protected AbstractLocalizedRuntimeException(Throwable cause,
                                            Code code,
                                            String bundleBaseName,
                                            String resourceKey)

Constructor.

Parameters:

cause - the cause (which is saved for later retrieval by the AbstractCoreRuntimeException.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

code - the error or exception code of the exception.

bundleBaseName - the fully qualified name of the bundle to use.

resourceKey - the localization key to fetch messages from message bundles.

See Also:

AbstractCoreRuntimeException.AbstractCoreRuntimeException(String, Throwable, Code)

Method Detail

getResourceKey

public final String getResourceKey()

Returns the localization key to fetch messages from message bundles. If this value is not set, the String representation of the AbstractCoreRuntimeException.getCode() instance is used.

Returns:

the localization key to fetch messages from message bundles.

getBundleBaseName

public final String getBundleBaseName()

Returns the fully qualified base name of the bundle to use.

Returns:

the fully qualified base name of the bundle to use.

getMessage

public final String getMessage(MessageType messageType)

Returns the message for the given message type and the system's default locale.

Specified by:

getMessage in interface LocalizedException

Parameters:

messageType - the type if message to return.

Returns:

the message for the given message type.

getMessage

public final String getMessage()

Returns the detail message string of this throwable.

Returns the localized message for the default locale.

Specified by:

getMessage in interface CoreException

Overrides:

getMessage in class Throwable

Returns:

the detail message string of this Throwable instance (which may be null).

See Also:

Throwable.getMessage()

getMessage

public final String getMessage(Locale locale,
                               MessageType messageType)

Returns the message for the given message type.

Specified by:

getMessage in interface LocalizedException

Parameters:

locale - the locale to select the localized message.

messageType - the type if message to return.

Returns:

the message for the given message type.

getLocalizedMessage

public final String getLocalizedMessage()

Returns the localized message according to the system's default locale.

Creates a localized description of this throwable. Subclasses may override this method in order to produce a locale-specific message. For subclasses that do not override this method, the default implementation returns the same result as getMessage().

Specified by:

getLocalizedMessage in interface CoreException

Overrides:

getLocalizedMessage in class Throwable

Returns:

The localized description of this throwable.

getLocalizedMessage

public final String getLocalizedMessage(Locale locale)

Returns the localized message for the given locale.

Parameters:

locale - the locale for which the message is requested.

Returns:

returns the localized message of this exception.

getLocalizedMessage

public final String getLocalizedMessage(Locale locale,
                                        ClassLoader loader)

Returns the localized message for the given locale.

Parameters:

locale - the locale for which the message is requested.

loader - the loader to read the message bundle.

Returns:

returns the localized message of this exception.

getLocalizedMessage

public final String getLocalizedMessage(String keyPrefix,
                                        Locale locale,
                                        MessageType messageType,
                                        ClassLoader loader)

Returns the localized message for the given locale.

Parameters:

keyPrefix - the prefix of the key to load from the bundle.

locale - the locale for which the message is requested.

messageType - the type of message to localize.

loader - the loader to read the message bundle.

Returns:

returns the localized message of this exception.

To Do:

Should we really provide these methods with class loader and control? What is the user scenario for this?

getMessages

public final String getMessages()

Description copied from interface: LocalizedException

Returns the messages in one string. Useful to make a dump of all text information for all message types for debugging.

Uses the default locale to access the messages.

Specified by:

getMessages in interface LocalizedException

Returns:

a dump of all types of messages.

getMessages

public final String getMessages(Locale locale)

Description copied from interface: LocalizedException

Returns the messages in one string. Useful to make a dump of all text information for all message types for debugging.

Specified by:

getMessages in interface LocalizedException

Parameters:

locale - the locale to use for the dump.

Returns:

a dump of all types of messages.

createMessages

public final Messages createMessages()

Description copied from interface: LocalizedException

Returns a created messages instance.

Uses the default locale to access the messages.

Specified by:

createMessages in interface LocalizedException

Returns:

messages of all types.

createMessages

public final Messages createMessages(Locale locale)

Description copied from interface: LocalizedException

Returns a created messages instance.

Specified by:

createMessages in interface LocalizedException

Parameters:

locale - the locale to use for the dump.

Returns:

messages of all types.

getCauseTrail

public final CauseTrailMessages getCauseTrail()

Description copied from interface: LocalizedException

Returns the cause trail of messages. These are all messages of the cause to the root cause.

Specified by:

getCauseTrail in interface LocalizedException

Returns:

the cause trail of messages.

getCauseTrail

public final CauseTrailMessages getCauseTrail(Locale locale)

Description copied from interface: LocalizedException

Returns the cause trail of messages. These are all messages of the cause to the root cause.

Specified by:

getCauseTrail in interface LocalizedException

Parameters:

locale - the locale to use for the dump.

Returns:

the cause trail of messages.

toString

public String toString()

Returns the string representation of the exception.

May be overridden by subclasses in an application (not a library) to change the string representation. Usually an implementation of I18nCodeMessageFormatter should be set to the ExceptionContext.

Overrides:

toString in class AbstractCoreRuntimeException

Returns:

the string representation of the object.