net.dpml.cli.resource

Class 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

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

Method Details

getBundleName

public String getBundleName()
Return the resource bundle name.
Returns:
the name

getMessage

public String getMessage(String key)
Returns the message for the specified key.
Parameters:
key - the unique identifier of the message
Returns:
String the formatted String

getMessage

public String getMessage(String key,
                         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 String getMessage(String key,
                         Object value1,
                         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 String getMessage(String key,
                         Object value1,
                         Object value2,
                         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 String getMessage(String key,
                         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

getResourceHelper

public static ResourceHelper getResourceHelper()
Gets the ResourceHelper appropriate to the specified class.
Returns:
a ResourceHelper