com.hp.util.format

Class FormatUtils

java.lang.Object

com.hp.util.format.FormatUtils

public class FormatUtils
extends Object

Utility methods for classes in the format package.

Author:

Scott Pontillo

Constructor Summary

Constructors

Constructor and Description
FormatUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	constructTokenMessage(String key) Constructs a token suitable for use by a default RestrictedTokenMessageTranslator and a ResourceBundleTokenTranslator.
static String	constructTokenMessage(String key, String[] args) Returns a string in the form '%{key[:arg0[,arg1,...,argn]]}', where n is the length of the 'args' array.
static String	convertIllegalCharacters(String s) Converts an arbitrary String to be used with a default RestrictedTokenMessageTranslator and a ResourceBundleTokenTranslator.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatUtils

public FormatUtils()

Method Detail

constructTokenMessage

public static String constructTokenMessage(String key,
                           String[] args)

Returns a string in the form '%{key[:arg0[,arg1,...,argn]]}', where n is the length of the 'args' array. This method is to be used with the ResourceBundleTokenTranslator and RestrictedTokenMessageTranslator classes.

Parameters:

key - The key into the resource bundle that will be decoded later by translate()

args - The arguments to use for the MessageFormat

Returns:

the translatable string

See Also:

ResourceBundleTokenTranslator, RestrictedTokenMessageTranslator

constructTokenMessage

public static String constructTokenMessage(String key)

Constructs a token suitable for use by a default RestrictedTokenMessageTranslator and a ResourceBundleTokenTranslator. Does not place any arguments into the token.

Parameters:

key - to be converted to a token

Returns:

the token message string in form of %{key}

See Also:

constructTokenMessage(java.lang.String, java.lang.String[])

convertIllegalCharacters

public static String convertIllegalCharacters(String s)

Converts an arbitrary String to be used with a default RestrictedTokenMessageTranslator and a ResourceBundleTokenTranslator. Strips all control characters (characters where 0 <= charValue < 32) and converts them to spaces.

Parameters:

s - string to be converted

Returns:

string with control characters converted to spaces