MessageResources

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> struts >> [ util overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.util
Class MessageResources

java.lang.Object
  org.apache.struts.util.MessageResources

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: PropertyMessageResources

public abstract class MessageResources
extends java.lang.Object
implements java.io.Serializable

General purpose abstract class that describes an API for retrieving Locale-sensitive messages from underlying resource locations of an unspecified design, and optionally utilizing the MessageFormat class to produce internationalized messages with parametric replacement.

Calls to getMessage() variants without a Locale argument are presumed to be requesting a message string in the default Locale for this JVM.

Calls to getMessage() with an unknown key, or an unknown Locale will return null if the returnNull property is set to true. Otherwise, a suitable error message will be returned instead.

IMPLEMENTATION NOTE - Classes that extend this class must be Serializable so that instances may be used in distributable application server environments.

Version:: $Rev: 264684 $ $Date: 2005-08-30 04:08:01 +0100 (Tue, 30 Aug 2005) $

Field Summary

protected java.lang.String config
          The configuration parameter used to initialize this MessageResources.

protected static MessageResourcesFactory defaultFactory
          The default MessageResourcesFactory used to create MessageResources instances.

protected java.util.Locale defaultLocale
          The default Locale for our environment.

private boolean escape
          Indicates whether 'escape processing' should be performed on the error message string.

protected MessageResourcesFactory factory
          The MessageResourcesFactory that created this instance.

protected java.util.HashMap formats
          The set of previously created MessageFormat objects, keyed by the key computed in messageKey().

protected static org.apache.commons.logging.Log log
          Commons Logging instance.

protected boolean returnNull
          Indicate is a null is returned instead of an error message string when an unknown Locale or key is requested.

Constructor Summary

MessageResources(MessageResourcesFactory factory, java.lang.String config)
          Construct a new MessageResources according to the specified parameters.

MessageResources(MessageResourcesFactory factory, java.lang.String config, boolean returnNull)
          Construct a new MessageResources according to the specified parameters.

Method Summary

protected java.lang.String escape(java.lang.String string)
          Escape any single quote characters that are included in the specified message string.

java.lang.String getConfig()
          The configuration parameter used to initialize this MessageResources.

MessageResourcesFactory getFactory()
          The MessageResourcesFactory that created this instance.

abstract java.lang.String getMessage(java.util.Locale locale, java.lang.String key)
          Returns a text message for the specified key, for the default Locale.

java.lang.String getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object[] args)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0, java.lang.Object arg1)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.lang.String key)
          Returns a text message for the specified key, for the default Locale.

java.lang.String getMessage(java.lang.String key, java.lang.Object arg0)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.lang.String key, java.lang.Object[] args)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
          Returns a text message after parametric replacement of the specified parameter placeholders.

java.lang.String getMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
          Returns a text message after parametric replacement of the specified parameter placeholders.

static MessageResources getMessageResources(java.lang.String config)
          Create and return an instance of MessageResources for the created by the default MessageResourcesFactory.

boolean getReturnNull()
          Indicates that a null is returned instead of an error message string if an unknown Locale or key is requested.

boolean isEscape()
          Indicates whether 'escape processing' should be performed on the error message string.

boolean isPresent(java.util.Locale locale, java.lang.String key)
          Return true if there is a defined message for the specified key in the specified Locale.

boolean isPresent(java.lang.String key)
          Return true if there is a defined message for the specified key in the system default locale.

protected java.lang.String localeKey(java.util.Locale locale)
          Compute and return a key to be used in caching information by a Locale.

void log(java.lang.String message)
          Log a message to the Writer that has been configured for our use.

void log(java.lang.String message, java.lang.Throwable throwable)
          Log a message and exception to the Writer that has been configured for our use.

protected java.lang.String messageKey(java.util.Locale locale, java.lang.String key)
          Compute and return a key to be used in caching information by Locale and message key.

protected java.lang.String messageKey(java.lang.String localeKey, java.lang.String key)
          Compute and return a key to be used in caching information by locale key and message key.

void setEscape(boolean escape)
          Set whether 'escape processing' should be performed on the error message string.

void setReturnNull(boolean returnNull)
          Indicates that a null is returned instead of an error message string if an unknown Locale or key is requested.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

Commons Logging instance.

config

protected java.lang.String config

The configuration parameter used to initialize this MessageResources.

defaultLocale

protected java.util.Locale defaultLocale

The default Locale for our environment.

factory

protected MessageResourcesFactory factory

The MessageResourcesFactory that created this instance.

formats

protected java.util.HashMap formats

The set of previously created MessageFormat objects, keyed by the key computed in messageKey().

returnNull

protected boolean returnNull

Indicate is a null is returned instead of an error message string when an unknown Locale or key is requested.

escape

private boolean escape

Indicates whether 'escape processing' should be performed on the error message string.

defaultFactory

protected static MessageResourcesFactory defaultFactory

The default MessageResourcesFactory used to create MessageResources instances.

Constructor Detail