com.dpslink.base.util

Class Messages

java.lang.Object

com.dpslink.base.util.Messages

All Implemented Interfaces:

java.io.Serializable

public class Messages
extends java.lang.Object
implements java.io.Serializable

A utility class for retrieving and formatting messages obtained from Profile.

All message keys retrieved by this class are assumed to be prefixed with "MSG.". Message keys supplied to this class' methods that are not already prefixed with "MSG." will be automatically prefixed when the key is retrieved.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
Messages()

Method Summary

Modifier and Type	Method and Description
static boolean	exists(java.lang.String msgid) Answers if the given message id exists.
static java.lang.String	get(java.lang.String msgid) Returns the message text for a given message id.
static java.lang.String	get(java.lang.String msgid, java.lang.String... values) Returns the message text for a given message id with the given set of substitution value(s) inserted into the message text.
private static java.lang.String	getString(java.lang.String msgid) Returns the message text for a given message id.
static java.lang.String	stripLogLevel(java.lang.String msgtext) Strips the log level (DEBUG, INFO, WARN, etc.) from the given message text.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

Messages

public Messages()

Method Detail

get

public static java.lang.String get(java.lang.String msgid)

Returns the message text for a given message id. Returns an error message text if the message id cannot be found.

Parameters:

msgid - (String) The resource key for the message to retrieve. If necessary, the msgid is automatically prefixed with "MSG.".

Returns:

String - The message text.

get

public static java.lang.String get(java.lang.String msgid,
                                   java.lang.String... values)

Returns the message text for a given message id with the given set of substitution value(s) inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgid - (String) The resource key for the message to retrieve. If necessary, the msgid is automatically prefixed with "MSG.".

values - (String) The value(s) that are to be substituted into the message text. This parameter uses the varargs feature and can therefore be passed as multiple parms (msgid, value1, value2, value3, valueN) or as an array (msgid, values[]).

Returns:

String - The message text.

getString

private static java.lang.String getString(java.lang.String msgid)

Returns the message text for a given message id. Returns an error message text if the message id cannot be found.

Parameters:

msgid - (String) The resource key for the message to retrieve. If necessary, the msgid is automatically prefixed with "MSG.".

Returns:

String - The text associated with the given id.

exists

public static boolean exists(java.lang.String msgid)

Answers if the given message id exists.

Parameters:

msgid - (String) The resource key for the message to check. If necessary, the msgid is automatically prefixed with "MSG.".

Returns:

boolean - true if the message id exists, otherwise false.

stripLogLevel

public static java.lang.String stripLogLevel(java.lang.String msgtext)

Strips the log level (DEBUG, INFO, WARN, etc.) from the given message text.

Parameters:

msgtext - (String) The message text to process.

Returns:

String - The given message text sans log level.