com.google.gwt.i18n.server

Class AbstractMessageInterface

java.lang.Object

com.google.gwt.i18n.server.AbstractMessageInterface

All Implemented Interfaces:

MessageInterface

Direct Known Subclasses:

ReflectionMessageInterface, TypeOracleMessageInterface

public abstract class AbstractMessageInterface
extends Object
implements MessageInterface

Base implementation of MessageInterface.

Field Summary

Fields

Modifier and Type	Field and Description
protected GwtLocaleFactory	factory

Constructor Summary

Constructors

Constructor and Description
AbstractMessageInterface(GwtLocaleFactory factory)

Method Summary

Modifier and Type	Method and Description
void	accept(MessageInterfaceVisitor cv) Visit this class and all messages within it, using the default locale.
void	accept(MessageInterfaceVisitor cv, GwtLocale locale) Visit this class and all messages within it.
abstract <A extends Annotation> A	getAnnotation(Class<A> annotClass) Return the requested annotation present on this message, including parents if the annotation is inherited.
abstract String	getClassName() Get the unqualified class name (including parent classes for nested classes - ie, "Foo.Bar") of this MessageInterface.
abstract Iterable<Message>	getMessages() Gets the list of messages defined in this interface, including inherited.
abstract String	getPackageName() Get the package name (ie, "org.example") of this MessageInterface.
abstract String	getQualifiedName() Get the fully qualified source name (ie, "org.example.Foo.Bar": if Bar is an inner class of Foo) of this message interface - generally used for error messages.
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).
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Field Detail

factory

protected final GwtLocaleFactory factory

Constructor Detail

AbstractMessageInterface

public AbstractMessageInterface(GwtLocaleFactory factory)

Method Detail

accept

public void accept(MessageInterfaceVisitor cv)
            throws MessageProcessingException

Description copied from interface: MessageInterface

Visit this class and all messages within it, using the default locale.

Specified by:

accept in interface MessageInterface

Throws:

MessageProcessingException

accept

public void accept(MessageInterfaceVisitor cv,
                   GwtLocale locale)
            throws MessageProcessingException

Description copied from interface: MessageInterface

Visit this class and all messages within it.

Specified by:

accept in interface MessageInterface

Throws:

MessageProcessingException

getAnnotation

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

Description copied from interface: MessageInterface

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

Specified by:

getAnnotation in interface MessageInterface

Returns:

an annotation instance or null if not found

getClassName

public abstract String getClassName()

Description copied from interface: MessageInterface

Get the unqualified class name (including parent classes for nested classes - ie, "Foo.Bar") of this MessageInterface.

Specified by:

getClassName in interface MessageInterface

Returns:

unqualified class name

getMessages

public abstract Iterable<Message> getMessages()
                                       throws MessageProcessingException

Gets the list of messages defined in this interface, including inherited. These must be returned in order of Message.getKey().

Returns:

an iteration of Message instances

Throws:

MessageProcessingException

getPackageName

public abstract String getPackageName()

Description copied from interface: MessageInterface

Get the package name (ie, "org.example") of this MessageInterface.

Specified by:

getPackageName in interface MessageInterface

Returns:

package name

getQualifiedName

public abstract String getQualifiedName()

Description copied from interface: MessageInterface

Get the fully qualified source name (ie, "org.example.Foo.Bar": if Bar is an inner class of Foo) of this message interface - generally used for error messages.

Specified by:

getQualifiedName in interface MessageInterface

Returns:

fully qualified source name

isAnnotationPresent

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

Description copied from interface: MessageInterface

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

Specified by:

isAnnotationPresent in interface MessageInterface

Returns:

true if the annotation is present

toString

public String toString()

Overrides:

toString in class Object