org.codehaus.griffon.runtime.core.i18n

Class AbstractMessageSource

java.lang.Object

org.codehaus.griffon.runtime.core.i18n.AbstractMessageSource

All Implemented Interfaces:

MessageSource

Direct Known Subclasses:

CompositeMessageSource, DefaultMessageSource

public abstract class AbstractMessageSource
extends Object
implements MessageSource

Since:

2.0.0

Author:

Andres Almiray, Alexander Klein

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object[]	EMPTY_OBJECT_ARGS
protected static String	ERROR_ARGS_NULL
protected static String	ERROR_KEY_BLANK
protected static String	ERROR_LOCALE_NULL
protected static String	ERROR_MESSAGE_BLANK

Fields inherited from interface griffon.core.i18n.MessageSource

REF_KEY_END, REF_KEY_START

Constructor Summary

Constructors

Constructor and Description
AbstractMessageSource()

Method Summary

Modifier and Type	Method and Description
protected abstract Object	doResolveMessageValue(String key, Locale locale)
protected Object	evalMessageWithArguments(Object message, Map<String,Object> args)
protected Object	evalMessageWithArguments(Object message, Object[] args)
String	formatMessage(String message, List<?> args) Formats the given message using supplied args to substitute placeholders.
String	formatMessage(String message, Map<String,Object> args) Formats the given message using supplied args to substitute placeholders.
String	formatMessage(String message, Object[] args) Formats the given message using supplied args to substitute placeholders.
String	getMessage(String key) Try to resolve the message.
String	getMessage(String key, List<?> args) Try to resolve the message.
String	getMessage(String key, List<?> args, Locale locale) Try to resolve the message.
String	getMessage(String key, List<?> args, Locale locale, String defaultMessage) Try to resolve the message.
String	getMessage(String key, List<?> args, String defaultMessage) Try to resolve the message.
String	getMessage(String key, Locale locale) Try to resolve the message.
String	getMessage(String key, Locale locale, String defaultMessage) Try to resolve the message.
String	getMessage(String key, Map<String,Object> args) Try to resolve the message.
String	getMessage(String key, Map<String,Object> args, Locale locale) Try to resolve the message.
String	getMessage(String key, Map<String,Object> args, Locale locale, String defaultMessage) Try to resolve the message.
String	getMessage(String key, Map<String,Object> args, String defaultMessage) Try to resolve the message.
String	getMessage(String key, Object[] args) Try to resolve the message.
String	getMessage(String key, Object[] args, Locale locale) Try to resolve the message.
String	getMessage(String key, Object[] args, Locale locale, String defaultMessage) Try to resolve the message.
String	getMessage(String key, Object[] args, String defaultMessage) Try to resolve the message.
String	getMessage(String key, String defaultMessage) Try to resolve the message.
Object	resolveMessageValue(String key, Locale locale) Resolve a message given a key and a Locale.
protected Object[]	toObjectArray(List<?> args)

Methods inherited from class java.lang.Object

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

Methods inherited from interface griffon.core.i18n.MessageSource

asResourceBundle

Field Detail

ERROR_KEY_BLANK

protected static final String ERROR_KEY_BLANK

See Also:

Constant Field Values

ERROR_LOCALE_NULL

protected static final String ERROR_LOCALE_NULL

See Also:

Constant Field Values

ERROR_ARGS_NULL

protected static final String ERROR_ARGS_NULL

See Also:

Constant Field Values

ERROR_MESSAGE_BLANK

protected static final String ERROR_MESSAGE_BLANK

See Also:

Constant Field Values

EMPTY_OBJECT_ARGS

protected static final Object[] EMPTY_OBJECT_ARGS

Constructor Detail

AbstractMessageSource

public AbstractMessageSource()

Method Detail

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

Returns:

The resolved message at the given key for the default locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  Locale locale)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

locale - Locale in which to lookup

Returns:

The resolved message at the given key for the given locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  Object[] args)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

Returns:

The resolved message at the given key for the default locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  Object[] args,
                                  @Nonnull
                                  Locale locale)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

Returns:

The resolved message at the given key for the given locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  List<?> args)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

Returns:

The resolved message at the given key for the default locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  List<?> args,
                                  @Nonnull
                                  Locale locale)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

Returns:

The resolved message at the given key for the given locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the default locale

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   Locale locale,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

locale - Locale in which to lookup

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the given locale

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   Object[] args,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the default locale

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   Object[] args,
                                   @Nonnull
                                   Locale locale,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the given locale

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   List<?> args,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the default locale

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   List<?> args,
                                   @Nonnull
                                   Locale locale,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the given locale

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  Map<String,Object> args)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{:key}" within a message, but this might differ between implementations), or null if none.

Returns:

The resolved message at the given key for the default locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nonnull
public String getMessage(@Nonnull
                                  String key,
                                  @Nonnull
                                  Map<String,Object> args,
                                  @Nonnull
                                  Locale locale)
                           throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{:key}" within a message, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

Returns:

The resolved message at the given key for the given locale

Throws:

NoSuchMessageException - if no message is found

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   Map<String,Object> args,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{:key}" within a message, but this might differ between implementations), or null if none.

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the default locale

getMessage

@Nullable
public String getMessage(@Nonnull
                                   String key,
                                   @Nonnull
                                   Map<String,Object> args,
                                   @Nonnull
                                   Locale locale,
                                   @Nullable
                                   String defaultMessage)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

args - Arguments that will be filled in for params within the message (params look like "{:key}" within a message, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

defaultMessage - Message to return if the lookup fails

Returns:

The resolved message at the given key for the given locale

resolveMessageValue

@Nonnull
public Object resolveMessageValue(@Nonnull
                                           String key,
                                           @Nonnull
                                           Locale locale)
                                    throws NoSuchMessageException

Description copied from interface: MessageSource

Resolve a message given a key and a Locale.

This method should use the default Locale if the locale argument is null. The key argument may refer to another key if the resolved value results in a CharSequence that begins with "@[" and ends with "]". In this case the method will use the enclosed value as the next key to be resolved. For example, given the following key/value definitions

     some.key = Hello {0}
     other.key = @[some.key]
 

Evaluating the keys results in

    assert resolveMessageValue('some.key', Locale.default) == 'Hello {0}'
    assert resolveMessageValue('other.key', Locale.default) == 'Hello {0}'
 

Specified by:

resolveMessageValue in interface MessageSource

Parameters:

key - Key to lookup, such as 'log4j.appenders.console'

locale - Locale in which to lookup

Returns:

the resolved message value at the given key for the given locale

Throws:

NoSuchMessageException - if no message is found

formatMessage

@Nonnull
public String formatMessage(@Nonnull
                                     String message,
                                     @Nonnull
                                     List<?> args)

Description copied from interface: MessageSource

Formats the given message using supplied args to substitute placeholders.

Specified by:

formatMessage in interface MessageSource

Parameters:

message - The message following a predefined format.

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

Returns:

the formatted message with all matching placeholders with their substituted values.

formatMessage

@Nonnull
public String formatMessage(@Nonnull
                                     String message,
                                     @Nonnull
                                     Object[] args)

Description copied from interface: MessageSource

Formats the given message using supplied args to substitute placeholders.

Specified by:

formatMessage in interface MessageSource

Parameters:

message - The message following a predefined format.

args - Arguments that will be filled in for params within the message (params look like "{0}" within a message, but this might differ between implementations), or null if none.

Returns:

the formatted message with all matching placeholders with their substituted values.

formatMessage

@Nonnull
public String formatMessage(@Nonnull
                                     String message,
                                     @Nonnull
                                     Map<String,Object> args)

Description copied from interface: MessageSource

Formats the given message using supplied args to substitute placeholders.

Specified by:

formatMessage in interface MessageSource

Parameters:

message - The message following a predefined format.

args - Arguments that will be filled in for params within the message (params look like "{:key}" within a message, but this might differ between implementations), or null if none.

Returns:

the formatted message with all matching placeholders with their substituted values.

doResolveMessageValue

@Nonnull
protected abstract Object doResolveMessageValue(@Nonnull
                                                         String key,
                                                         @Nonnull
                                                         Locale locale)
                                                  throws NoSuchMessageException

Throws:

NoSuchMessageException

evalMessageWithArguments

@Nullable
protected Object evalMessageWithArguments(@Nonnull
                                                    Object message,
                                                    @Nonnull
                                                    Object[] args)

evalMessageWithArguments

@Nullable
protected Object evalMessageWithArguments(@Nonnull
                                                    Object message,
                                                    @Nonnull
                                                    Map<String,Object> args)

toObjectArray

@Nonnull
protected Object[] toObjectArray(@Nonnull
                                          List<?> args)