com.google.gwt.i18n.server

Interface Message

All Superinterfaces:

Comparable<Message>, MessageTranslation

All Known Implementing Classes:

AbstractMessage, ReflectionMessage, TypeOracleMessage

public interface Message
extends Comparable<Message>, MessageTranslation

Describes a single translatable message.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Message.AlternateFormMapping Mapping for a group of particular alternate forms to the message to use.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(MessageVisitor v) Accept a MessageVisitor.
void	accept(MessageVisitor v, GwtLocale locale) Accept a MessageVisitor, using translations from the requested locale.
int	compareTo(Message o) Messages are ordered by their keys.
Iterable<Message.AlternateFormMapping>	getAllMessageForms() Get the list of all possible messages.
<A extends Annotation> A	getAnnotation(Class<A> annotClass) Return the requested annotation present on this message, including parents if the annotation is inherited.
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.
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.
String	getMethodName() Return the name of the method for this message - this should generally only be used in providing error messages.
List<Parameter>	getParameters() Get the parameters defined for this message.
Type	getReturnType() Return the declared return type for this message.
int[]	getSelectorParameterIndices() Get the list of parameters controlling alternate message selection.
MessageTranslation	getTranslation(GwtLocale locale) Get an appropriate translation for this message for a given locale.
boolean	isAnnotationPresent(Class<? extends Annotation> annotClass) Check if a specified annotation is present on this message (including via inheritance if the annotation is inherited).
boolean	isVarArgs() Return true if this method is a varargs method.

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

getMatchedLocale

Method Detail

accept

void accept(MessageVisitor v)
            throws MessageProcessingException

Accept a MessageVisitor.

Parameters:

v - MessageVisitor to call

Throws:

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

accept

void accept(MessageVisitor v,
          GwtLocale locale)
            throws MessageProcessingException

Accept a MessageVisitor, using translations from the requested locale.

Parameters:

v - 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

int compareTo(Message o)

Messages are ordered by their keys.

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

Iterable<Message.AlternateFormMapping> getAllMessageForms()

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 MessageTranslation

Returns:

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

getAnnotation

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

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

Parameters:

annotClass -

Returns:

an annotation instance or null if not found

getDefaultMessage

String getDefaultMessage()

Return the default form of this message.

Specified by:

getDefaultMessage in interface MessageTranslation

Returns:

default message or null if not provided

getDescription

String getDescription()

Return the description of this message.

Returns:

description or null if not provided

getKey

String getKey()

Return the key associated with this message.

Returns:

key to use for message lookups

getMeaning

String getMeaning()

Return the meaning of this message.

Returns:

meaning or null if not provided

getMessageInterface

MessageInterface getMessageInterface()

Return the MessageInterface this message is associated with.

Returns:

a MessageInterface instance

getMessageStyle

MessageFormatUtils.MessageStyle getMessageStyle()

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

Returns:

MessageStyle instance for this message

getMethodName

String getMethodName()

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

Returns:

default message or null if not provided

getParameters

List<Parameter> getParameters()

Get the parameters defined for this message.

Returns:

a possibly empty list of parameters

getReturnType

Type getReturnType()

Return the declared return type for this message.

Returns:

the declared return type

getSelectorParameterIndices

int[] getSelectorParameterIndices()

Get the list of parameters controlling alternate message selection.

Returns:

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

getTranslation

MessageTranslation getTranslation(GwtLocale locale)

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

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

boolean isAnnotationPresent(Class<? extends Annotation> annotClass)

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

Parameters:

annotClass -

Returns:

true if the annotation is present

isVarArgs

boolean isVarArgs()

Return true if this method is a varargs method.

Returns:

true if this method is a varargs method