com.opensymphony.xwork2
Class DefaultTextProvider

java.lang.Object
  extended by com.opensymphony.xwork2.DefaultTextProvider
All Implemented Interfaces:
TextProvider, Unchainable, java.io.Serializable

public class DefaultTextProvider
extends java.lang.Object
implements TextProvider, java.io.Serializable, Unchainable

DefaultTextProvider gets texts from only the default resource bundles associated with the LocalizedTextUtil.

Author:
Jason Carreira , Rainer Hermanns
See Also:
LocalizedTextUtil.addDefaultResourceBundle(String), Serialized Form

Constructor Summary
DefaultTextProvider()
           
 
Method Summary
 java.lang.String getText(java.lang.String key)
          Gets a message based on a message key, or null if no message is found.
 java.lang.String getText(java.lang.String key, java.util.List<?> args)
          Gets a message based on a key using the supplied args, as defined in MessageFormat, or null if no message is found.
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue)
          Gets a message based on a key, or, if the message is not found, a supplied default value is returned.
 java.lang.String getText(java.lang.String key, java.lang.String[] args)
          Gets a message based on a key using the supplied args, as defined in MessageFormat, or null if no message is found.
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.util.List<?> args)
          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.
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.util.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.
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String obj)
          Gets a message based on a key using the supplied obj, as defined in MessageFormat, or, if the message is not found, a supplied default value is returned.
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String[] args)
          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.
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.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.
 java.util.ResourceBundle getTexts()
          Get the resource bundle associated with the implementing class (usually an action).
 java.util.ResourceBundle getTexts(java.lang.String bundleName)
          Get the named bundle, such as "com/acme/Foo".
 boolean hasKey(java.lang.String key)
          Checks if a message key exists.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultTextProvider

public DefaultTextProvider()
Method Detail

hasKey

public boolean hasKey(java.lang.String key)
Description copied from interface: TextProvider
Checks if a message key exists.

Specified by:
hasKey in interface TextProvider
Parameters:
key - message key to check for
Returns:
boolean true if key exists, false otherwise.

getText

public java.lang.String getText(java.lang.String key)
Description copied from interface: TextProvider
Gets a message based on a message key, or null if no message is found.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
Returns:
the message as found in the resource bundle, or null if none is found.

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue)
Description copied from interface: TextProvider
Gets a message based on a key, or, if the message is not found, a supplied default value is returned.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
defaultValue - the default value which will be returned if no message is found
Returns:
the message as found in the resource bundle, or defaultValue if none is found

getText

public java.lang.String getText(java.lang.String key,
                                java.util.List<?> args)
Description copied from interface: TextProvider
Gets a message based on a key using the supplied args, as defined in MessageFormat, or null if no message is found.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
args - a list args to be used in a MessageFormat message
Returns:
the message as found in the resource bundle, or null if none is found.

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String[] args)
Description copied from interface: TextProvider
Gets a message based on a key using the supplied args, as defined in MessageFormat, or null if no message is found.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
args - an array args to be used in a MessageFormat message
Returns:
the message as found in the resource bundle, or null if none is found.

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.util.List<?> args)
Description copied from interface: TextProvider
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.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
defaultValue - the default value which will be returned if no message is found
args - a list args to be used in a MessageFormat message
Returns:
the message as found in the resource bundle, or defaultValue if none is found

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String[] args)
Description copied from interface: TextProvider
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.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
defaultValue - the default value which will be returned if no message is found
args - an array args to be used in a MessageFormat message
Returns:
the message as found in the resource bundle, or defaultValue if none is found

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String obj)
Description copied from interface: TextProvider
Gets a message based on a key using the supplied obj, as defined in MessageFormat, or, if the message is not found, a supplied default value is returned.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
defaultValue - the default value which will be returned if no message is found
obj - obj to be used in a MessageFormat message
Returns:
the message as found in the resource bundle, or defaultValue if none is found

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.util.List<?> args,
                                ValueStack stack)
Description copied from interface: TextProvider
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. Instead of using the value stack in the ActionContext this version of the getText() method uses the provided value stack.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
defaultValue - the default value which will be returned if no message is found
args - a list args to be used in a MessageFormat message
stack - the value stack to use for finding the text
Returns:
the message as found in the resource bundle, or defaultValue if none is found

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String[] args,
                                ValueStack stack)
Description copied from interface: TextProvider
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. Instead of using the value stack in the ActionContext this version of the getText() method uses the provided value stack.

Specified by:
getText in interface TextProvider
Parameters:
key - the resource bundle key that is to be searched for
defaultValue - the default value which will be returned if no message is found
args - an array args to be used in a MessageFormat message
stack - the value stack to use for finding the text
Returns:
the message as found in the resource bundle, or defaultValue if none is found

getTexts

public java.util.ResourceBundle getTexts(java.lang.String bundleName)
Description copied from interface: TextProvider
Get the named bundle, such as "com/acme/Foo".

Specified by:
getTexts in interface TextProvider
Parameters:
bundleName - the name of the resource bundle, such as "com/acme/Foo".
Returns:
the bundle

getTexts

public java.util.ResourceBundle getTexts()
Description copied from interface: TextProvider
Get the resource bundle associated with the implementing class (usually an action).

Specified by:
getTexts in interface TextProvider
Returns:
the bundle


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.