net.dpml.cli.resource

Class ResourceHelper

java.lang.Object

net.dpml.cli.resource.ResourceHelper

public final class ResourceHelper
extends java.lang.Object

A utility class used to provide internationalisation support.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBundleName() Return the resource bundle name.
java.lang.String	getMessage(java.lang.String key) Returns the message for the specified key.
java.lang.String	getMessage(java.lang.String key, java.lang.Object value) Returns the message for the specified key and argument.
java.lang.String	getMessage(java.lang.String key, java.lang.Object[] values) Returns the message for the specified key and arguments.
java.lang.String	getMessage(java.lang.String key, java.lang.Object value1, java.lang.Object value2) Returns the message for the specified key and arguments.
java.lang.String	getMessage(java.lang.String key, java.lang.Object value1, java.lang.Object value2, java.lang.Object value3) Returns the message for the specified key and arguments.
static ResourceHelper	getResourceHelper() Gets the ResourceHelper appropriate to the specified class.

Methods inherited from class java.lang.Object

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

Method Detail

getBundleName

public java.lang.String getBundleName()

Return the resource bundle name.

Returns:

the name

getResourceHelper

public static ResourceHelper getResourceHelper()

Gets the ResourceHelper appropriate to the specified class.

Returns:

a ResourceHelper

getMessage

public java.lang.String getMessage(java.lang.String key)

Returns the message for the specified key.

Parameters:

key - the unique identifier of the message

Returns:

String the formatted String

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object value)

Returns the message for the specified key and argument.

Parameters:

key - the unique identifier of the message

value - the argument value

Returns:

String the formatted String

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object value1,
                                   java.lang.Object value2)

Returns the message for the specified key and arguments.

Parameters:

key - the unique identifier of the message

value1 - an argument value

value2 - an argument value

Returns:

String the formatted String

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object value1,
                                   java.lang.Object value2,
                                   java.lang.Object value3)

Returns the message for the specified key and arguments.

Parameters:

key - the unique identifier of the message

value1 - an argument value

value2 - an argument value

value3 - an argument value

Returns:

String the formatted String

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] values)

Returns the message for the specified key and arguments.

Parameters:

key - the unique identifier of the message

values - argument values

Returns:

String the formatted String