|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.apache.uima.InternationalizedRuntimeException
public class InternationalizedRuntimeException
The InternationalizedRuntimeException class adds internationalization support to
the standard functionality provided by java.lang.RuntimeException. Because this
is a RuntimeException, it does not need to be declared in the throws clause of
methods.
To support internationalization, the thrower of an exception must not specify a hardcoded message
string. Instead, the thrower specifies a key that identifies the message. That key is then looked
up in a locale-specific ResourceBundle to find the actual
message associated with this exception.
This class also supports arguments to messages. The full message will be constructed using the
MessageFormat class. For more information on
internationalization, see the
Java Internationalization Guide.
This version of this class works with JDK versions prior to 1.4, since it does not assume support
for exception chaining. The file InternationalizedException.java_1_4 is a version
that uses the exception chaining support built-in to JDK1.4.
| Constructor Summary | |
|---|---|
InternationalizedRuntimeException()
Creates a new InternationalizedRuntimeException with a null message. |
|
InternationalizedRuntimeException(String aResourceBundleName,
String aMessageKey,
Object[] aArguments)
Creates a new InternationalizedRuntimeException with the specified message. |
|
InternationalizedRuntimeException(String aResourceBundleName,
String aMessageKey,
Object[] aArguments,
Throwable aCause)
Creates a new InternationalizedRuntimeException with the specified message and
cause. |
|
InternationalizedRuntimeException(Throwable aCause)
Creates a new InternationalizedRuntimeException with the specified cause and a
null message. |
|
| Method Summary | |
|---|---|
Object[] |
getArguments()
Gets the arguments to this exception's message. |
Throwable |
getCause()
Gets the cause of this Exception. |
String |
getLocalizedMessage()
Gets the localized detail message for this exception. |
String |
getLocalizedMessage(Locale aLocale)
Gets the localized detail message for this exception using the specified Locale. |
String |
getMessage()
Gets the English detail message for this exception. |
String |
getMessageKey()
Gets the identifier for this exception's message. |
String |
getResourceBundleName()
Gets the base name of the resource bundle in which the message for this exception is located. |
Throwable |
initCause(Throwable cause)
|
| Methods inherited from class java.lang.Throwable |
|---|
fillInStackTrace, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public InternationalizedRuntimeException()
InternationalizedRuntimeException with a null message.
public InternationalizedRuntimeException(Throwable aCause)
InternationalizedRuntimeException with the specified cause and a
null message.
aCause - the original exception that caused this exception to be thrown, if any
public InternationalizedRuntimeException(String aResourceBundleName,
String aMessageKey,
Object[] aArguments)
InternationalizedRuntimeException with the specified message.
aResourceBundleName - the base name of the resource bundle in which the message for this exception is
located.aMessageKey - an identifier that maps to the message for this exception. The message may contain
placeholders for arguments as defined by the
MessageFormat class.aArguments - The arguments to the message. null may be used if the message has no
arguments.
public InternationalizedRuntimeException(String aResourceBundleName,
String aMessageKey,
Object[] aArguments,
Throwable aCause)
InternationalizedRuntimeException with the specified message and
cause.
aResourceBundleName - the base name of the resource bundle in which the message for this exception is
located.aMessageKey - an identifier that maps to the message for this exception. The message may contain
placeholders for arguments as defined by the
MessageFormat class.aArguments - The arguments to the message. null may be used if the message has no
arguments.aCause - the original exception that caused this exception to be thrown, if any| Method Detail |
|---|
public String getResourceBundleName()
null if this exception has no
message.public String getMessageKey()
ResourceBundle to get the locale-specific message
for this exception.
null if
this exception has no message.public Object[] getArguments()
InternationalizedRuntimeException to have a compound message, made up of
multiple parts that are concatenated in a language-neutral way.
public String getMessage()
getLocalizedMessage().
getMessage in class Throwablepublic String getLocalizedMessage()
getLocalizedMessage(Locale).
getLocalizedMessage in class Throwablepublic String getLocalizedMessage(Locale aLocale)
Locale.
aLocale - the locale to use for localizing the message
Locale.public Throwable getCause()
getCause in class Throwablenull
if there is no such cause.public Throwable initCause(Throwable cause)
initCause in class Throwable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||