| java.lang.Object
 org.jasig.portal.lang.ThrowableHelper
| ThrowableHelper | | final public class ThrowableHelper (Code) | | The ThrowableHelper class defines a set of utility
methods for handling common error management operations in a
fashion which takes advantage of the J2SDK 1.4 constructs while
maintaining J2SDK 1.3 compatibility.
author:
Jan Nielsen
version:
"$Revision: 35982 $" |
| Method Summary | |
| final public static Throwable | create(Class throwableClass, Class client, String propertyName, String[] args, Throwable cause)
Creates the specified Throwable object with the
internationalized error code and arguments. | | final public static ThrowableHandler | getDefaultHandler(String className)
Returns a constructed instance of the default handler. | | final public static String | getInternationalizedMessage(Class client, String error)
Returns an internationalized error message which can be
reconstructed into a localized error message with the
getLocalizedMessage method call. | | final public static String | getInternationalizedMessage(Class client, String error, String[] objects)
Returns an internationalized error message which can be
reconstructed into a localized error message with the
getLocalizedMessage method call. | | final public static String | getLocalizedMessage(String i18nMessage)
Returns the localized error message associated with the
specified internationalized error message constructed with the
getInternationalizedMessage method. | | final public static String | getLocalizedMessage(Throwable throwable)
Returns the localized string associated with the argument. | | final public static String | getLocalizedMessage(Throwable throwable, Locale locale)
Returns the localized string associated with the argument
in the specified locale, if possible. | | final public static String | getLocalizedMessage(String i18nMessage, Locale locale)
Returns the localized error message associated with the
specified internationalized error message constructed with the
getInternationalizedMessage method. | | final public static void | handle(Throwable cause)
Handles the throwable condition specified in the parameter. | | final public static void | handle(Class client, String message, String[] objects, Throwable cause)
Handles the throwable condition specified in the
parameters. | | final public static void | handle(Class client, String message, String[] objects, Throwable cause, ThrowableHandler handler)
Handles the throwable condition specified in the parameters. | | final public static void | initCause(Throwable throwable, Throwable cause)
Initizlizes the chained cause of the throwable if possible
using the J2SDK 1.4 constructs. |
| create | | final public static Throwable create(Class throwableClass, Class client, String propertyName, String[] args, Throwable cause)(Code) | | Creates the specified Throwable object with the
internationalized error code and arguments. If the cause object
is not null, the specified object's initCause
method will be invoked reflectively to enable the standard
chaining constructs. The specified error code is an
internationalized error property value which must be defined in
a resource bundle associated with the client, specificifically
the code will perform a ResourceBundle.getBundle( ) to resolve the resource.
Invoking this method is equivalent to creating the
Throwable with an internationalized message and
then invoking ThrowableHelper.initCause, e.g.,:
Throwable someCause = ...
String i18nMessage = ThrowableHelper.getInternationalizedMessage(
MyApplication.class,
"myapplication.some_error_code",
new String[]{ "32", "1024" }
);
IllegalArgumentException iae = new IllegalArgumentException(
i18nMessage
);
ThrowableHelper.initCause(
iae,
someCause
);
Parameters:
throwableClass - throwable object to be constructed
Parameters:
client - class file of the client
Parameters:
propertyName - internationalized error code property namedefined in the client's resouce bundle
Parameters:
args - arguments for the localized message
Parameters:
cause - cause of the created exception, ornull throwable object of the specified type |
| getDefaultHandler | | final public static ThrowableHandler getDefaultHandler(String className)(Code) | | Returns a constructed instance of the default handler. The
class name passed to the method must be an implementation of
the ThrowableHandler interface and have an
accessible default constructor.
Parameters:
className - name of the throwable handler class instance of the specified handler class, or the defaulterror handler |
| getInternationalizedMessage | | final public static String getInternationalizedMessage(Class client, String error)(Code) | | Returns an internationalized error message which can be
reconstructed into a localized error message with the
getLocalizedMessage method call.
Parameters:
client - class of the client making this call
Parameters:
error - error property name of the error condition internationalized error message |
| getInternationalizedMessage | | final public static String getInternationalizedMessage(Class client, String error, String[] objects)(Code) | | Returns an internationalized error message which can be
reconstructed into a localized error message with the
getLocalizedMessage method call.
Parameters:
client - class of the client making this call
Parameters:
error - error property name of the error condition
Parameters:
objects - string objects which should be stored for themessage internationalized error message
throws:
NullPointerException - if client, or error parameters arenull |
| getLocalizedMessage | | final public static String getLocalizedMessage(String i18nMessage)(Code) | | Returns the localized error message associated with the
specified internationalized error message constructed with the
getInternationalizedMessage method. The default
locale is used.
Parameters:
i18nMessage - internationalized error message localized error message, or null |
| getLocalizedMessage | | final public static String getLocalizedMessage(Throwable throwable)(Code) | | Returns the localized string associated with the argument.
Parameters:
throwable - object whose message is to be localized localized message associated with Throwable |
| getLocalizedMessage | | final public static String getLocalizedMessage(Throwable throwable, Locale locale)(Code) | | Returns the localized string associated with the argument
in the specified locale, if possible. If the locale is not
supported the default locale message will be returned.
Parameters:
throwable - object whose message is to be localized
Parameters:
locale - locale to localized the message localized message associated with Throwable |
| getLocalizedMessage | | final public static String getLocalizedMessage(String i18nMessage, Locale locale)(Code) | | Returns the localized error message associated with the
specified internationalized error message constructed with the
getInternationalizedMessage method. The locale of
for the translation is picked up from the current session.
Parameters:
i18nMessage - internationalized error message
Parameters:
locale - locale to translate the message localized error message, or null |
| handle | | final public static void handle(Throwable cause)(Code) | | Handles the throwable condition specified in the parameter. The
default handler is used to process this handler.
Parameters:
cause - throwable condition which should be handled |
| handle | | final public static void handle(Class client, String message, String[] objects, Throwable cause)(Code) | | Handles the throwable condition specified in the
parameters. The default handler is used to process this
handler.
Parameters:
client - client performing the handling
Parameters:
cause - throwable condition which should be handled
Parameters:
message - associated with handling the error
Parameters:
objects - associated with the error message |
| handle | | final public static void handle(Class client, String message, String[] objects, Throwable cause, ThrowableHandler handler)(Code) | | Handles the throwable condition specified in the parameters. If
the specified handler is null the default handler
is used; otherwise, the specified handler is used to process
this request.
Parameters:
client - client performing the handling
Parameters:
cause - throwable condition which should be handled
Parameters:
message - associated with handling the error
Parameters:
objects - associated with the error message
Parameters:
handler - which should be executed instead of the defaulthandler |
| initCause | | final public static void initCause(Throwable throwable, Throwable cause)(Code) | | Initizlizes the chained cause of the throwable if possible
using the J2SDK 1.4 constructs. In a J2SDK pre-1.4 environment,
this method does nothing.
Parameters:
throwable - throwable whose cause should be set
Parameters:
cause - throwable which caused the throwable condition |
|
|