|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.opensymphony.xwork2.TextProviderSupport
public class TextProviderSupport
Default TextProvider implementation.
| Constructor Summary | |
|---|---|
TextProviderSupport()
Default constructor |
|
TextProviderSupport(Class clazz,
LocaleProvider provider)
Constructor. |
|
TextProviderSupport(ResourceBundle bundle,
LocaleProvider provider)
Constructor. |
|
| Method Summary | |
|---|---|
String |
getText(String key)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
List<?> args)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
String defaultValue)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
String[] args)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
String defaultValue,
List<?> args)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
String defaultValue,
List<?> args,
ValueStack stack)
Gets a message based on a key using the supplied args, as defined in MessageFormat, or, if the message is not found, a supplied
default value is returned. |
String |
getText(String key,
String defaultValue,
String arg)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
String defaultValue,
String[] args)
Get a text from the resource bundles associated with this action. |
String |
getText(String key,
String defaultValue,
String[] args,
ValueStack stack)
Gets a message based on a key using the supplied args, as defined in MessageFormat, or, if the message is not found, a supplied
default value is returned. |
ResourceBundle |
getTexts()
Get the resource bundle associated with this action. |
ResourceBundle |
getTexts(String aBundleName)
Get the named bundle. |
boolean |
hasKey(String key)
Checks if a key is available in the resource bundles associated with this action. |
void |
setBundle(ResourceBundle bundle)
Set the resource bundle to use. |
void |
setClazz(Class clazz)
Set the class to use for reading the resource bundle. |
void |
setLocaleProvider(LocaleProvider localeProvider)
Set the LocaleProvider to use. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TextProviderSupport()
public TextProviderSupport(Class clazz,
LocaleProvider provider)
clazz - a clazz to use for reading the resource bundle.provider - a locale provider.
public TextProviderSupport(ResourceBundle bundle,
LocaleProvider provider)
bundle - the resource bundle.provider - a locale provider.| Method Detail |
|---|
public void setBundle(ResourceBundle bundle)
ResourceBundleTextProvider
setBundle in interface ResourceBundleTextProviderbundle - the resource bundle.public void setClazz(Class clazz)
ResourceBundleTextProvider
setClazz in interface ResourceBundleTextProviderclazz - a clazz to use for reading the resource bundle.public void setLocaleProvider(LocaleProvider localeProvider)
ResourceBundleTextProvider
setLocaleProvider in interface ResourceBundleTextProviderlocaleProvider - a locale provider.public boolean hasKey(String key)
hasKey in interface TextProviderkey - message key to check for
public String getText(String key)
getText in interface TextProviderkey - name of text to be found
public String getText(String key,
String defaultValue)
getText in interface TextProviderkey - name of text to be founddefaultValue - the default value which will be returned if no text is found
public String getText(String key,
String defaultValue,
String arg)
getText in interface TextProviderkey - name of text to be founddefaultValue - the default value which will be returned if no text is foundarg - obj to be used in a MessageFormat message
public String getText(String key,
List<?> args)
getText in interface TextProviderkey - name of text to be foundargs - a List of args to be used in a MessageFormat message
public String getText(String key,
String[] args)
getText in interface TextProviderkey - name of text to be foundargs - an array of args to be used in a MessageFormat message
public String getText(String key,
String defaultValue,
List<?> args)
getText in interface TextProviderkey - name of text to be founddefaultValue - the default value which will be returned if no text is foundargs - a List of args to be used in a MessageFormat message
public String getText(String key,
String defaultValue,
String[] args)
getText in interface TextProviderkey - name of text to be founddefaultValue - the default value which will be returned if no text is foundargs - an array of args to be used in a MessageFormat message
public String getText(String key,
String defaultValue,
List<?> args,
ValueStack stack)
MessageFormat, or, if the message is not found, a supplied
default value is returned. Instead of using the value stack in the ActionContext
this version of the getText() method uses the provided value stack.
getText in interface TextProviderkey - the resource bundle key that is to be searched fordefaultValue - the default value which will be returned if no message is foundargs - a list args to be used in a MessageFormat messagestack - the value stack to use for finding the text
public String getText(String key,
String defaultValue,
String[] args,
ValueStack stack)
MessageFormat, or, if the message is not found, a supplied
default value is returned. Instead of using the value stack in the ActionContext
this version of the getText() method uses the provided value stack.
getText in interface TextProviderkey - the resource bundle key that is to be searched fordefaultValue - the default value which will be returned if no message is foundargs - an array args to be used in a MessageFormat messagestack - the value stack to use for finding the text
public ResourceBundle getTexts(String aBundleName)
getTexts in interface TextProvideraBundleName - bundle name
public ResourceBundle getTexts()
getTexts in interface TextProvider
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||