com.ausregistry.jtoolkit2

Class ErrorPkg

java.lang.Object

com.ausregistry.jtoolkit2.ErrorPkg

public final class ErrorPkg
extends java.lang.Object

A flexible library message reporting facility which supports customisation of messages using a plain text messages file. See the description of init for usage information. Uses the debug, support and user level loggers.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getMessage(java.lang.String name) Get the message for a given message identifier/name.
static java.lang.String	getMessage(java.lang.String name, java.lang.String[] args, int[] vals) Returns the message.
static java.lang.String	getMessage(java.lang.String name, java.lang.String[] args, java.lang.String[] vals) Get the message for a given message identifier/name, replacing each token specified in args with the corresponding value specified in vals.
static java.lang.String	getMessage(java.lang.String name, java.lang.String arg, java.util.Date date)
static java.lang.String	getMessage(java.lang.String name, java.lang.String arg, java.lang.String val) Get the message for a given message identifier/name, replacing the specified token identified by arg with the value specified by val.
static java.lang.String	getMessage(java.lang.String name, java.lang.String arg, java.security.cert.X509Certificate certificate)
static void	init() Initialise the ErrorPkg class from a messages file.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()
                 throws java.io.IOException,
                        java.io.FileNotFoundException

Initialise the ErrorPkg class from a messages file. This is automatically called at the time the class is loaded. Ths messages definition file must be in the classpath.

Throws:

java.io.IOException - The messages couldn't be loaded from a message file into the internal Properties object.

java.io.FileNotFoundException - The messages file couldn't be found.

getMessage

public static java.lang.String getMessage(java.lang.String name)

Get the message for a given message identifier/name.

Parameters:

name - The identifier of a message, as specified as a key in the messages file.

Returns:

The value in the loaded messages file corresponding to the key identified by the name parameter.

getMessage

public static java.lang.String getMessage(java.lang.String name,
                                          java.lang.String arg,
                                          java.lang.String val)

Get the message for a given message identifier/name, replacing the specified token identified by arg with the value specified by val.

Parameters:

name - The identifier of a message, as specified as a key in the messages file.

arg - The token identifier to replace.

val - The value to replace the token identifier with.

Returns:

The value in the loaded messages file corresponding to the key identified by the name parameter, with the token name replaced by the given value.

getMessage

public static java.lang.String getMessage(java.lang.String name,
                                          java.lang.String[] args,
                                          java.lang.String[] vals)

Get the message for a given message identifier/name, replacing each token specified in args with the corresponding value specified in vals.

Parameters:

name - The identifier of a message, as specified as a key in the messages file.

args - The array of token identifiers to replace.

vals - The array of values to replace the token identifiers with.

Returns:

The value in the loaded messages file corresponding to the key identified by the name parameter, with the token identifiers replaced by the given value.

getMessage

public static java.lang.String getMessage(java.lang.String name,
                                          java.lang.String[] args,
                                          int[] vals)

Returns the message.

Parameters:

name - The identifier of a message, as specified as a key in the messages file.

args - The array of token identifiers to replace.

vals - The array of values to replace the token identifiers with.

Returns:

The value in the loaded messages file corresponding to the key identified by the name parameter, with the token identifiers replaced by the given value.

getMessage

public static java.lang.String getMessage(java.lang.String name,
                                          java.lang.String arg,
                                          java.util.Date date)

getMessage

public static java.lang.String getMessage(java.lang.String name,
                                          java.lang.String arg,
                                          java.security.cert.X509Certificate certificate)