org.safs.text

Class ResourceMessageInfo

java.lang.Object

org.safs.text.ResourceMessageInfo

All Implemented Interfaces:

java.lang.Cloneable

public class ResourceMessageInfo
extends java.lang.Object
implements java.lang.Cloneable

Contain information of NLS message in resource bundle.

Author:

Lei Wang, SAS Institute, Inc Lei Wang SEP 10, 2012 Add method clone().

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLENAME_FAILEDTEXT
static java.lang.String	BUNDLENAME_GENERICTEXT

Constructor Summary

Constructors

Constructor and Description
ResourceMessageInfo()
ResourceMessageInfo(java.lang.String key)
ResourceMessageInfo(java.lang.String resourceBundleName, java.lang.String key)
ResourceMessageInfo(java.lang.String resourceBundleName, java.lang.String key, java.util.List<java.lang.String> params)

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String value)
ResourceMessageInfo	clone() When we assign the instance of ResourceMessageInfo to an other object, we should assign the cloned one.
java.lang.String	getAltText()
java.lang.String	getKey()
java.lang.String	getMessage() Attempt to get and convert the desired message out of the resource bundle and return it as a String with all parameters substituted.
java.util.List<java.lang.String>	getParams()
java.lang.String	getResourceBundleName()
void	reset()
void	setAltText(java.lang.String altText)
void	setAltText(java.lang.String altTextWithPlaceholder, java.lang.String placeHolderDelim) The field params must be set before calling this method. The params will contain the values to replace the placeholders in alternative text.
void	setKey(java.lang.String key)
void	setParams(java.util.List<java.lang.String> params)
void	setParams(java.lang.String[] sparams)
void	setResourceBundleName(java.lang.String resourceBundleName)

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLENAME_FAILEDTEXT

public static final java.lang.String BUNDLENAME_FAILEDTEXT

See Also:

Constant Field Values

BUNDLENAME_GENERICTEXT

public static final java.lang.String BUNDLENAME_GENERICTEXT

See Also:

Constant Field Values

Constructor Detail

ResourceMessageInfo

public ResourceMessageInfo()

ResourceMessageInfo

public ResourceMessageInfo(java.lang.String key)

ResourceMessageInfo

public ResourceMessageInfo(java.lang.String resourceBundleName,
                           java.lang.String key)

ResourceMessageInfo

public ResourceMessageInfo(java.lang.String resourceBundleName,
                           java.lang.String key,
                           java.util.List<java.lang.String> params)

Method Detail

reset

public void reset()

getResourceBundleName

public java.lang.String getResourceBundleName()

setResourceBundleName

public void setResourceBundleName(java.lang.String resourceBundleName)

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

getParams

public java.util.List<java.lang.String> getParams()

setParams

public void setParams(java.util.List<java.lang.String> params)

setParams

public void setParams(java.lang.String[] sparams)

addParameter

public void addParameter(java.lang.String value)

getAltText

public java.lang.String getAltText()

setAltText

public void setAltText(java.lang.String altText)

setAltText

public void setAltText(java.lang.String altTextWithPlaceholder,
                       java.lang.String placeHolderDelim)

The field params must be set before calling this method.
The params will contain the values to replace the placeholders in alternative text.

Parameters:

altTextWithPlaceholder - String, text with placeholder as %1%, %2% etc.

placeHolderDelim - String, such as %, used to replace placeholder by real parameter value.

See Also:

params

getMessage

public java.lang.String getMessage()

Attempt to get and convert the desired message out of the resource bundle and return it as a String with all parameters substituted. If no resourceBundleName has been assigned, then the routine will assume it is the FAILEDTEXT resource bundle to use by default.

Returns:

the localized String, or null if a successful conversion could not be made.

clone

public ResourceMessageInfo clone()

When we assign the instance of ResourceMessageInfo to an other object, we should assign the cloned one.

Overrides:

clone in class java.lang.Object