org.hippoecm.hst.utils

Class MessageUtils

java.lang.Object

org.hippoecm.hst.utils.MessageUtils

public class MessageUtils
extends Object

MessageUtils

This utility class provides features to replace texts containing variables by looking up values from the resolved or given resource bundle.

If the variable is not found, then it returns the variable name wrapped by '???'.

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_ESCAPE Default escape character to override the default escape character of StrSubstitutor, '$'.

Method Summary

Modifier and Type	Method and Description
static String	replaceMessages(String basename, String text) Replaces the given text by looking up values from the resolved resource bundle by the basename.
static String	replaceMessages(String basename, String text, String variablePrefix, String variableSuffix) Replaces the given text by looking up values from the resolved resource bundle by the basename.
static String	replaceMessages(String basename, String text, String variablePrefix, String variableSuffix, Character escapeChar) Replaces the given text by looking up values from the resolved resource bundle by the basename.
static String	replaceMessagesByBundle(ResourceBundle bundle, String text) Replaces the given text by looking up values from the given resource bundle.
static String	replaceMessagesByBundle(ResourceBundle bundle, String text, String variablePrefix, String variableSuffix) Replaces the given text by looking up values from the given resource bundle.
static String	replaceMessagesByBundle(ResourceBundle bundle, String text, String variablePrefix, String variableSuffix, Character escapeChar) Replaces the given text by looking up values from the given resource bundle.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ESCAPE

public static final char DEFAULT_ESCAPE

Default escape character to override the default escape character of StrSubstitutor, '$'. '\\' is more user friendly than '$' in most use cases.

See Also:

Constant Field Values

Method Detail

replaceMessages

public static String replaceMessages(String basename,
                                     String text)

Replaces the given text by looking up values from the resolved resource bundle by the basename.

Parameters:

basename - resource bundle base name

text - text to replace

Returns:

replaced string by the values found in the given resource bundle

replaceMessages

public static String replaceMessages(String basename,
                                     String text,
                                     String variablePrefix,
                                     String variableSuffix)

Replaces the given text by looking up values from the resolved resource bundle by the basename.

Parameters:

basename - resource bundle base name

text - text to replace

variablePrefix - variable reference prefix. "${" by default.

variableSuffix - variable reference suffix. "}" by default.

Returns:

replaced string by the values found in the given resource bundle

replaceMessages

public static String replaceMessages(String basename,
                                     String text,
                                     String variablePrefix,
                                     String variableSuffix,
                                     Character escapeChar)

Replaces the given text by looking up values from the resolved resource bundle by the basename.

Parameters:

basename - resource bundle base name

text - text to replace

variablePrefix - variable reference prefix. "${" by default.

variableSuffix - variable reference suffix. "}" by default.

escapeChar - escape character which can be put just before a variable reference to ignore the expression.

Returns:

replaced string by the values found in the given resource bundle

replaceMessagesByBundle

public static String replaceMessagesByBundle(ResourceBundle bundle,
                                             String text)

Replaces the given text by looking up values from the given resource bundle.

Parameters:

bundle - resource bundle

text - text to replace

Returns:

replaced string by the values found in the given resource bundle

replaceMessagesByBundle

public static String replaceMessagesByBundle(ResourceBundle bundle,
                                             String text,
                                             String variablePrefix,
                                             String variableSuffix)

Replaces the given text by looking up values from the given resource bundle.

Parameters:

bundle - resource bundle

text - text to replace

variablePrefix - variable reference prefix. "${" by default.

variableSuffix - variable reference suffix. "}" by default.

Returns:

replaced string by the values found in the given resource bundle

replaceMessagesByBundle

public static String replaceMessagesByBundle(ResourceBundle bundle,
                                             String text,
                                             String variablePrefix,
                                             String variableSuffix,
                                             Character escapeChar)

Replaces the given text by looking up values from the given resource bundle.

Parameters:

bundle - resource bundle

text - text to replace

variablePrefix - variable reference prefix. "${" by default.

variableSuffix - variable reference suffix. "}" by default.

escapeChar - escape character which can be put just before a variable reference to ignore the expression.

Returns:

replaced string by the values found in the given resource bundle