info.magnolia.cms.i18n
Class AbstractMessagesImpl

java.lang.Object
  info.magnolia.cms.i18n.AbstractMessagesImpl

All Implemented Interfaces:

Messages

Direct Known Subclasses:

DefaultMessagesImpl, EmptyMessages, MessagesChain

public abstract class AbstractMessagesImpl
extends java.lang.Object
implements Messages

Provides localized strings. You should uses the ContextMessages class if you can provide a request object. AbstractMessagesImpl will do the job as good as possible without to know the session (user) and all the other contextual things. Endusers will use the MessageManager to resolve messages.

Author:

Philipp Bracher

Field Summary

protected java.lang.String	basename The name of the bundle.
protected java.util.ResourceBundle	bundle The current bundle.
static java.lang.String	JS_OBJECTNAME Name of the javascript object used to make the messages public to the javascripts.
protected java.util.Locale	locale The current locale.
protected org.slf4j.Logger	log

Constructor Summary

protected

AbstractMessagesImpl(java.lang.String basename, java.util.Locale locale)

Method Summary

boolean	equals(java.lang.Object arg0) True if the basename and the locale are the same.
java.lang.String	get(java.lang.String key, java.lang.Object[] args) Replace the {n} parameters in the string.
java.lang.String	getBasename() If no basename is provided this method returns DEFAULT_BASENAME.
java.util.Locale	getLocale() Returns the current locale.
java.lang.String	getWithDefault(java.lang.String key, java.lang.Object[] args, java.lang.String defaultMsg) With default value and replacement strings.
java.lang.String	getWithDefault(java.lang.String key, java.lang.String defaultMsg) You can provide a default value if the key is not found.
java.lang.String	toString() Nice string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.cms.i18n.Messages

get, keys, reload

Field Detail

log

protected org.slf4j.Logger log

JS_OBJECTNAME

public static final java.lang.String JS_OBJECTNAME

Name of the javascript object used to make the messages public to the javascripts.

See Also:

Constant Field Values

basename

protected java.lang.String basename

The name of the bundle.

locale

protected java.util.Locale locale

The current locale.

bundle

protected java.util.ResourceBundle bundle

The current bundle. Subclasses will overwrite getBundle().

Constructor Detail

AbstractMessagesImpl

protected AbstractMessagesImpl(java.lang.String basename,
                               java.util.Locale locale)

Method Detail

getLocale

public java.util.Locale getLocale()

Returns the current locale.

Specified by:

getLocale in interface Messages

Returns:

current locale

getBasename

public java.lang.String getBasename()

If no basename is provided this method returns DEFAULT_BASENAME.

Specified by:

getBasename in interface Messages

Returns:

current basename

get

public java.lang.String get(java.lang.String key,
                            java.lang.Object[] args)

Replace the {n} parameters in the string.

Specified by:

get in interface Messages

See Also:

MessageFormat.format(String, Object[])

getWithDefault

public java.lang.String getWithDefault(java.lang.String key,
                                       java.lang.String defaultMsg)

You can provide a default value if the key is not found.

Specified by:

getWithDefault in interface Messages

Parameters:

key - key

defaultMsg - the default message

Returns:

the message

getWithDefault

public java.lang.String getWithDefault(java.lang.String key,
                                       java.lang.Object[] args,
                                       java.lang.String defaultMsg)

With default value and replacement strings.

Specified by:

getWithDefault in interface Messages

Parameters:

key - key

args - replacement strings

defaultMsg - default message

Returns:

message

equals

public boolean equals(java.lang.Object arg0)

True if the basename and the locale are the same.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Nice string.

Overrides:

toString in class java.lang.Object