SoyMsgBundleHandler (Closure Templates)

java.lang.Object
- com.google.template.soy.msgs.SoyMsgBundleHandler

```
public class SoyMsgBundleHandler
extends Object
```
Handler for writing SoyMsgBundles to file format and for creating SoyMsgBundles from files or resources.
Uses a SoyMsgPlugin to do the actual generation of the output data and the actual parsing of the input data. The SoyMsgPlugin implements the specific message file format.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SoyMsgBundleHandler.OutputFileOptions
Options for generating an output messages file.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SoyMsgBundleHandler.OutputFileOptions` Options for generating an output messages file.

Constructor Summary

Constructors
Constructor and Description

SoyMsgBundleHandler(SoyMsgPlugin msgPlugin)

Constructors
Constructor and Description
`SoyMsgBundleHandler(SoyMsgPlugin msgPlugin)`

Method Summary

Methods
Modifier and Type	Method and Description
`SoyMsgBundle`	`createFromFile(File inputFile)` Reads a translated messages file and creates a SoyMsgBundle.
`SoyMsgBundle`	`createFromResource(URL inputResource)` Reads a translated messages resource and creates a SoyMsgBundle.
`void`	`writeToExtractedMsgsFile(SoyMsgBundle msgBundle, SoyMsgBundleHandler.OutputFileOptions options, File outputFile)` Generates an extracted messages file (source messages to be translated) from a given message bundle, and writes it to file.
`void`	`writeToTranslatedMsgsFile(SoyMsgBundle msgBundle, SoyMsgBundleHandler.OutputFileOptions options, File outputFile)` Generates an translated messages file (source messages to be translated) from a given message bundle, and writes it to file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SoyMsgBundleHandler
```
@Inject
public SoyMsgBundleHandler(SoyMsgPlugin msgPlugin)
```
- Method Detail
  - createFromFile
```
public SoyMsgBundle createFromFile(File inputFile)
                            throws IOException,
                                   SoyMsgException
```
    Reads a translated messages file and creates a SoyMsgBundle.
    
    Parameters:
    inputFile - The input file to read from.
    
    Returns:
    The message bundle created from the messages file.
    
    Throws:
    
    IOException - If there's an error while accessing the file.
    
    SoyMsgException - If there's an error while processing the messages.
  - createFromResource
```
public SoyMsgBundle createFromResource(URL inputResource)
                                throws IOException,
                                       SoyMsgException
```
    Reads a translated messages resource and creates a SoyMsgBundle.
    
    Parameters:
    inputResource - The resource to read from.
    
    Returns:
    The message bundle created from the messages resource.
    
    Throws:
    
    IOException - If there's an error while accessing the resource.
    
    SoyMsgException - If there's an error while processing the messages.
  - writeToExtractedMsgsFile
```
public void writeToExtractedMsgsFile(SoyMsgBundle msgBundle,
                            SoyMsgBundleHandler.OutputFileOptions options,
                            File outputFile)
                              throws IOException,
                                     SoyMsgException
```
    Generates an extracted messages file (source messages to be translated) from a given message bundle, and writes it to file.
    Important: Do not use outside of Soy code (treat as superpackage-private).
    
    Parameters:
    msgBundle - The message bundle to write to file.
    options - The options for generating the output extracted messages file (depending on the message plugin being used, none or some of the options may be applicable).
    outputFile - The output file to write to.
    
    Throws:
    
    SoyMsgException - If there's an error while processing the messages.
    
    IOException - If there's an error while accessing the file.
  - writeToTranslatedMsgsFile
```
public void writeToTranslatedMsgsFile(SoyMsgBundle msgBundle,
                             SoyMsgBundleHandler.OutputFileOptions options,
                             File outputFile)
                               throws IOException,
                                      SoyMsgException
```
    Generates an translated messages file (source messages to be translated) from a given message bundle, and writes it to file.
    Important: Do not use outside of Soy code (treat as superpackage-private).
    
    Parameters:
    msgBundle - The message bundle to write to file.
    options - The options for generating the output translated messages file (depending on the message plugin being used, none or some of the options may be applicable).
    outputFile - The output file to write to.
    
    Throws:
    
    IOException - If there's an error while accessing the file.
    
    SoyMsgException - If there's an error while processing the messages.

Class SoyMsgBundleHandler

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoyMsgBundleHandler

Method Detail

createFromFile

createFromResource

writeToExtractedMsgsFile

writeToTranslatedMsgsFile