com.google.template.soy.msgs

Interface SoyBidirectionalMsgPlugin

All Superinterfaces:

SoyMsgPlugin

public interface SoyBidirectionalMsgPlugin
extends SoyMsgPlugin

Plugin for implementing a specific message file format. Supports postprocessing of msgs files by having methods to both generate and parse both extracted and translated msgs files.

Method Summary

Modifier and Type	Method and Description
CharSequence	generateTranslatedMsgsFile(SoyMsgBundle msgBundle, SoyMsgBundleHandler.OutputFileOptions options) Builds the content of a translated msgs file from a given message bundle object.
SoyMsgBundle	parseExtractedMsgsFile(String extractedMsgsFileContent) Parses the content of an extracted messages file (source messages to be translated) and builds a message bundle object.

Methods inherited from interface com.google.template.soy.msgs.SoyMsgPlugin

generateExtractedMsgsFile, parseTranslatedMsgsFile

Method Detail

parseExtractedMsgsFile

SoyMsgBundle parseExtractedMsgsFile(String extractedMsgsFileContent)

Parses the content of an extracted messages file (source messages to be translated) and builds a message bundle object.

Currently, this method exists purely for consistency. There's currently no functionality in Soy that uses this method.

Parameters:

extractedMsgsFileContent - The content of the extracted messages file.

Returns:

The message bundle object built from the messages file.

Throws:

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

generateTranslatedMsgsFile

CharSequence generateTranslatedMsgsFile(SoyMsgBundle msgBundle,
                                        SoyMsgBundleHandler.OutputFileOptions options)

Builds the content of a translated msgs file from a given message bundle object.

For example, the given message bundle may be the result of postprocessing a message bundle parsed from an original translated msgs file.

Parameters:

msgBundle - The bundle of messages.

options - The options to use for generating the translated msgs file. Not all options will apply to all message plugins.

Returns:

The content of the generated translated msgs file.

Throws:

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