com.google.template.soy.msgs

Interface SoyMsgPlugin

All Known Subinterfaces:

SoyBidirectionalMsgPlugin

All Known Implementing Classes:

XliffMsgPlugin

public interface SoyMsgPlugin

Plugin for implementing a specific message file format.

Method Summary

Modifier and Type	Method and Description
CharSequence	generateExtractedMsgsFile(SoyMsgBundle msgBundle, SoyMsgBundleHandler.OutputFileOptions options, ErrorReporter errorReporter) Builds the content of an extracted messages file (source messages to be translated) from a given message bundle object containing messages extracted from source files.
SoyMsgBundle	parseTranslatedMsgsFile(String translatedMsgsFileContent) Parses the content of a translated messages file and builds a message bundle object.

Method Detail

generateExtractedMsgsFile

CharSequence generateExtractedMsgsFile(SoyMsgBundle msgBundle,
                                       SoyMsgBundleHandler.OutputFileOptions options,
                                       ErrorReporter errorReporter)

Builds the content of an extracted messages file (source messages to be translated) from a given message bundle object containing messages extracted from source files.

Parameters:

msgBundle - The bundle of messages extracted from source files.

options - The options to use for generating the extracted messages file (e.g. the source locale/language of the messages). Not all options will apply to all message plugins.

errorReporter - For reporting errors.

Returns:

The content of the generated extracted messages file.

Throws:

SoyMsgException - If there was an error building the file content.

parseTranslatedMsgsFile

SoyMsgBundle parseTranslatedMsgsFile(String translatedMsgsFileContent)

Parses the content of a translated messages file and builds a message bundle object.

Parameters:

translatedMsgsFileContent - The content of the translated messages file.

Returns:

The message bundle object built from the messages file.

Throws:

SoyMsgException - If there was an error parsing the file content.