com.google.gwt.i18n.server

Interface MessageCatalogFactory

All Known Implementing Classes:

PropertyCatalogFactory

public interface MessageCatalogFactory

Interface for writing various message catalog formats.

WARNING: this API is expected to change as we develop additional message catalog formats. In particular, this interface will be extended to support reading message catalogs and further changes may be required.

Implementations of this interface are executed at compile time and therefore must not contain any JSNI code.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageCatalogFactory.Context Context for message catalogs, for things like logging errors.
static interface	MessageCatalogFactory.Writer Writes translatable messages to a message catalog.

Method Summary

Methods

Modifier and Type	Method and Description
String	getExtension() Returns the extension to use for this file type, including the dot.
MessageCatalogFactory.Writer	getWriter(MessageCatalogFactory.Context context, String fileName) Return a MessageCatalogFactory.Writer that can be used to write the source of the messages to be translated for this class.

Method Detail

getExtension

String getExtension()

Returns the extension to use for this file type, including the dot.

getWriter

MessageCatalogFactory.Writer getWriter(MessageCatalogFactory.Context context,
                                     String fileName)
                                       throws MessageProcessingException

Return a MessageCatalogFactory.Writer that can be used to write the source of the messages to be translated for this class.

Parameters:

context -

fileName - relative path for output file, though implementations may ignore this value and use something else, such as an annotation giving a database key, for example

Returns:

MessageCatalogWriter instance or null if the output file could not be created

Throws:

MessageProcessingException