com.google.gwt.i18n.server

Class AbstractMessage

java.lang.Object

com.google.gwt.i18n.server.AbstractMessage

All Implemented Interfaces:

Message, MessageTranslation, Comparable<Message>

Direct Known Subclasses:

ReflectionMessage

public abstract class AbstractMessage
extends Object
implements Message

Base implementation of Message.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gwt.i18n.server.Message

Message.AlternateFormMapping

Constructor Summary

Constructors

Constructor and Description
AbstractMessage(GwtLocaleFactory localeFactory, MessageInterface msgIntf)

Method Summary

Modifier and Type	Method and Description
void	accept(MessageVisitor mv) Accept a MessageVisitor.
void	accept(MessageVisitor mv, GwtLocale locale) Accept a MessageVisitor, using translations from the requested locale.
protected void	addMapping(List<Message.AlternateFormMapping> mapping, int numSelectors, String joinedForms, String msg)
int	compareTo(Message o) Messages are ordered by their keys.
protected List<AlternateMessageSelector.AlternateForm>	defaultForms()
Iterable<Message.AlternateFormMapping>	getAllMessageForms() Get the list of all possible messages.
protected String[]	getAlternateMessages() Get the alternate message forms from either an AlternateMessages annotation or a PluralText annotation.
abstract <A extends Annotation> A	getAnnotation(Class<A> annotClass) Return the requested annotation present on this message, including parents if the annotation is inherited.
protected GwtLocale	getDefaultLocale()
String	getDefaultMessage() Return the default form of this message.
String	getDescription() Return the description of this message.
String	getKey() Return the key associated with this message.
protected GwtLocaleFactory	getLocaleFactory()
GwtLocale	getMatchedLocale() Get the locale for this translation.
String	getMeaning() Return the meaning of this message.
MessageInterface	getMessageInterface() Return the MessageInterface this message is associated with.
MessageFormatUtils.MessageStyle	getMessageStyle() Return the message style (ie, quoting and argument rules) of this message.
abstract String	getMethodName() Return the name of the method for this message - this should generally only be used in providing error messages.
abstract List<Parameter>	getParameters() Get the parameters defined for this message.
abstract Type	getReturnType() Return the declared return type for this message.
int[]	getSelectorParameterIndices() Get the list of parameters controlling alternate message selection.
abstract MessageTranslation	getTranslation(GwtLocale locale) Get an appropriate translation for this message for a given locale.
protected void	init() Called by subclasses to complete initialization, after ensuring that calls to getAnnotation(Class) will function properly.
abstract boolean	isAnnotationPresent(Class<? extends Annotation> annotClass) Check if a specified annotation is present on this message (including via inheritance if the annotation is inherited).
protected boolean	isStringMap()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Methods inherited from interface com.google.gwt.i18n.server.Message

isVarArgs

Constructor Detail

AbstractMessage

public AbstractMessage(GwtLocaleFactory localeFactory,
                       MessageInterface msgIntf)

Method Detail

accept

public void accept(MessageVisitor mv)
            throws MessageProcessingException

Description copied from interface: Message

Accept a MessageVisitor.

Specified by:

accept in interface Message

Parameters:

mv - MessageVisitor to call

Throws:

MessageProcessingException - if thrown by the visitor or its sub-visitors

accept

public void accept(MessageVisitor mv,
                   GwtLocale locale)
            throws MessageProcessingException

Description copied from interface: Message

Accept a MessageVisitor, using translations from the requested locale.

Specified by:

accept in interface Message

Parameters:

mv - MessageVisitor to call

locale - locale to use for translations, or null to use the messages present in the source

Throws:

MessageProcessingException - if thrown by the visitor or its sub-visitors

compareTo

public int compareTo(Message o)

Description copied from interface: Message

Messages are ordered by their keys.

Specified by:

compareTo in interface Message

Specified by:

compareTo in interface Comparable<Message>

Returns:

-1 if this message is before o, 0 if they are equal, or 1 if this is message is after {code o}

getAllMessageForms

public Iterable<Message.AlternateFormMapping> getAllMessageForms()

Description copied from interface: Message

Get the list of all possible messages. If there are not alternate message selectors, there will be a single entry with an empty list and the default value.

Specified by:

getAllMessageForms in interface Message

Specified by:

getAllMessageForms in interface MessageTranslation

Returns:

a list of all message forms, lexicographically sorted by the alternate forms for each message

getAnnotation

public abstract <A extends Annotation> A getAnnotation(Class<A> annotClass)

Description copied from interface: Message

Return the requested annotation present on this message, including parents if the annotation is inherited.

Specified by:

getAnnotation in interface Message

Returns:

an annotation instance or null if not found

getDefaultMessage

public String getDefaultMessage()

Description copied from interface: Message

Return the default form of this message.

Specified by:

getDefaultMessage in interface Message

Specified by:

getDefaultMessage in interface MessageTranslation

Returns:

default message or null if not provided

getDescription

public String getDescription()

Description copied from interface: Message

Return the description of this message.

Specified by:

getDescription in interface Message

Returns:

description or null if not provided

getKey

public String getKey()

Description copied from interface: Message

Return the key associated with this message.

Specified by:

getKey in interface Message

Returns:

key to use for message lookups

getMatchedLocale

public GwtLocale getMatchedLocale()

Description copied from interface: MessageTranslation

Get the locale for this translation.

Specified by:

getMatchedLocale in interface MessageTranslation

Returns:

locale instance

getMeaning

public String getMeaning()

Description copied from interface: Message

Return the meaning of this message.

Specified by:

getMeaning in interface Message

Returns:

meaning or null if not provided

getMessageInterface

public MessageInterface getMessageInterface()

Description copied from interface: Message

Return the MessageInterface this message is associated with.

Specified by:

getMessageInterface in interface Message

Returns:

a MessageInterface instance

getMessageStyle

public MessageFormatUtils.MessageStyle getMessageStyle()

Description copied from interface: Message

Return the message style (ie, quoting and argument rules) of this message.

Specified by:

getMessageStyle in interface Message

Returns:

MessageStyle instance for this message

getMethodName

public abstract String getMethodName()

Description copied from interface: Message

Return the name of the method for this message - this should generally only be used in providing error messages.

Specified by:

getMethodName in interface Message

Returns:

default message or null if not provided

getParameters

public abstract List<Parameter> getParameters()

Description copied from interface: Message

Get the parameters defined for this message.

Specified by:

getParameters in interface Message

Returns:

a possibly empty list of parameters

getReturnType

public abstract Type getReturnType()

Description copied from interface: Message

Return the declared return type for this message.

Specified by:

getReturnType in interface Message

Returns:

the declared return type

getSelectorParameterIndices

public int[] getSelectorParameterIndices()

Description copied from interface: Message

Get the list of parameters controlling alternate message selection.

Specified by:

getSelectorParameterIndices in interface Message

Returns:

possibly empty array of indices into the list returned by Message.getParameters()

getTranslation

public abstract MessageTranslation getTranslation(GwtLocale locale)

Description copied from interface: Message

Get an appropriate translation for this message for a given locale.

Specified by:

getTranslation in interface Message

Parameters:

locale - a locale to get a translation for, or null to retrieve the message in the source

Returns:

a non-null MessageTranslation instance - if locale is null, or no better match is found, this must be returned

isAnnotationPresent

public abstract boolean isAnnotationPresent(Class<? extends Annotation> annotClass)

Description copied from interface: Message

Check if a specified annotation is present on this message (including via inheritance if the annotation is inherited).

Specified by:

isAnnotationPresent in interface Message

Returns:

true if the annotation is present

addMapping

protected void addMapping(List<Message.AlternateFormMapping> mapping,
                          int numSelectors,
                          String joinedForms,
                          String msg)

defaultForms

protected List<AlternateMessageSelector.AlternateForm> defaultForms()

getAlternateMessages

protected String[] getAlternateMessages()

Get the alternate message forms from either an AlternateMessages annotation or a PluralText annotation.

getDefaultLocale

protected GwtLocale getDefaultLocale()

getLocaleFactory

protected GwtLocaleFactory getLocaleFactory()

init

protected void init()

Called by subclasses to complete initialization, after ensuring that calls to getAnnotation(Class) will function properly.

isStringMap

protected boolean isStringMap()