SoyGeneralOptions (Closure Templates)

java.lang.Object
- com.google.template.soy.shared.SoyGeneralOptions

All Implemented Interfaces:

Cloneable
```
public final class SoyGeneralOptions
extends Object
implements Cloneable
```
Compilation options applicable to the Soy frontend and/or to multiple Soy backends.

Constructor Summary

Constructors
Constructor and Description

SoyGeneralOptions()

Constructors
Constructor and Description
`SoyGeneralOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TriState`	`allowExternalCalls()` Returns whether to allow external calls (calls to undefined templates).
`SoyGeneralOptions`	`clone()`
`SoyGeneralOptions`	`disableOptimizer()` Disallow optimizer.
`com.google.common.collect.ImmutableMap<String,PrimitiveData>`	`getCompileTimeGlobals()` Returns the map from compile-time global name to value.
`SyntaxVersion`	`getDeclaredSyntaxVersion(SyntaxVersion defaultSyntaxVersion)` Returns the user-declared syntax version, or the given default value if the user did not declare a syntax version.
`com.google.common.collect.ImmutableSet<String>`	`getExperimentalFeatures()` Returns the set of enabled experimental features.
`boolean`	`isOptimizerEnabled()` Return true if we want to run optimizer in the compiler.
`TriState`	`isStrictAutoescapingRequired()` Returns whether strict autoescaping is required.
`SoyGeneralOptions`	`setAllowExternalCalls(boolean allowExternalCalls)` Sets whether to allow external calls (calls to undefined templates).
`SoyGeneralOptions`	`setCompileTimeGlobals(File compileTimeGlobalsFile)` Sets the file containing compile-time globals.
`SoyGeneralOptions`	`setCompileTimeGlobals(Map<String,?> compileTimeGlobalsMap)` Sets the map from compile-time global name to value.
`SoyGeneralOptions`	`setCompileTimeGlobals(URL compileTimeGlobalsResource)` Sets the resource file containing compile-time globals.
`SoyGeneralOptions`	`setDeclaredSyntaxVersionName(String versionName)` Sets the user-declared syntax version name for the Soy file bundle.
`SoyGeneralOptions`	`setExperimentalFeatures(Iterable<String> experimentalFeatures)` Sets experimental features.
`SoyGeneralOptions`	`setStrictAutoescapingRequired(boolean strictAutoescapingRequired)` Sets whether strict autoescaping is required.
`String`	`toString()`

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

- Constructor Detail
  - SoyGeneralOptions
```
public SoyGeneralOptions()
```
- Method Detail
  - disableOptimizer
```
public SoyGeneralOptions disableOptimizer()
```
    Disallow optimizer.
  - isOptimizerEnabled
```
public boolean isOptimizerEnabled()
```
    Return true if we want to run optimizer in the compiler.
  - setExperimentalFeatures
```
public SoyGeneralOptions setExperimentalFeatures(Iterable<String> experimentalFeatures)
```
    Sets experimental features. These features are unreleased and are not generally available.
  - getExperimentalFeatures
```
public com.google.common.collect.ImmutableSet<String> getExperimentalFeatures()
```
    Returns the set of enabled experimental features.
  - setDeclaredSyntaxVersionName
```
public SoyGeneralOptions setDeclaredSyntaxVersionName(@Nonnull
                                                      String versionName)
```
    Sets the user-declared syntax version name for the Soy file bundle.
    
    Parameters:
    
    versionName - The syntax version name, e.g. "1.0", "2.0", "2.3".
  - getDeclaredSyntaxVersion
```
public SyntaxVersion getDeclaredSyntaxVersion(SyntaxVersion defaultSyntaxVersion)
```
    Returns the user-declared syntax version, or the given default value if the user did not declare a syntax version.
    Important: Do not use outside of Soy code (treat as superpackage-private).
    
    Parameters:
    
    defaultSyntaxVersion - The default value to return if the user did not declare a syntax version.
  - setAllowExternalCalls
```
public SoyGeneralOptions setAllowExternalCalls(boolean allowExternalCalls)
```
    Sets whether to allow external calls (calls to undefined templates).
    
    Parameters:
    
    allowExternalCalls - The value to set.
  - allowExternalCalls
```
public TriState allowExternalCalls()
```
    Returns whether to allow external calls (calls to undefined templates). If this option was never explicitly set, then returns TriState.UNSET.
  - setStrictAutoescapingRequired
```
public SoyGeneralOptions setStrictAutoescapingRequired(boolean strictAutoescapingRequired)
```
    Sets whether strict autoescaping is required.
    
    Parameters:
    
    strictAutoescapingRequired - Whether autoescaping is required.
  - isStrictAutoescapingRequired
```
public TriState isStrictAutoescapingRequired()
```
    Returns whether strict autoescaping is required. If this option was never explicitly set, then returns TriState.UNSET.
  - setCompileTimeGlobals
```
public SoyGeneralOptions setCompileTimeGlobals(Map<String,?> compileTimeGlobalsMap)
```
    Sets the map from compile-time global name to value.
    The values can be any of the Soy primitive types: null, boolean, integer, float (Java double), or string.
    
    Parameters:
    
    compileTimeGlobalsMap - Map from compile-time global name to value. The values can be any of the Soy primitive types: null, boolean, integer, float (Java double), or string.
    
    Throws:
    
    IllegalArgumentException - If one of the values is not a valid Soy primitive type.
  - setCompileTimeGlobals
```
public SoyGeneralOptions setCompileTimeGlobals(File compileTimeGlobalsFile)
                                        throws IOException
```
    Sets the file containing compile-time globals.
    Each line of the file should have the format
```
     <global_name> = <primitive_data>
 
```
    where primitive_data is a valid Soy expression literal for a primitive type (null, boolean, integer, float, or string). Empty lines and lines beginning with "//" are ignored. The file should be encoded in UTF-8.
    If you need to generate a file in this format from Java, consider using the utility SoyUtils.generateCompileTimeGlobalsFile().
    Parameters:
    
    compileTimeGlobalsFile - The file containing compile-time globals.
    
    Throws:
    
    IOException - If there is an error reading the compile-time globals file.
  - setCompileTimeGlobals
```
public SoyGeneralOptions setCompileTimeGlobals(URL compileTimeGlobalsResource)
                                        throws IOException
```
    Sets the resource file containing compile-time globals.
    Each line of the file should have the format
```
     <global_name> = <primitive_data>
 
```
    where primitive_data is a valid Soy expression literal for a primitive type (null, boolean, integer, float, or string). Empty lines and lines beginning with "//" are ignored. The file should be encoded in UTF-8.
    If you need to generate a file in this format from Java, consider using the utility SoyUtils.generateCompileTimeGlobalsFile().
    Parameters:
    
    compileTimeGlobalsResource - The resource file containing compile-time globals.
    
    Throws:
    
    IOException - If there is an error reading the compile-time globals file.
  - getCompileTimeGlobals
```
public com.google.common.collect.ImmutableMap<String,PrimitiveData> getCompileTimeGlobals()
```
    Returns the map from compile-time global name to value.
  - clone
```
public final SoyGeneralOptions clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class SoyGeneralOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoyGeneralOptions

Method Detail

disableOptimizer

isOptimizerEnabled

setExperimentalFeatures

getExperimentalFeatures

setDeclaredSyntaxVersionName

getDeclaredSyntaxVersion

setAllowExternalCalls

allowExternalCalls

setStrictAutoescapingRequired

isStrictAutoescapingRequired

setCompileTimeGlobals

setCompileTimeGlobals

setCompileTimeGlobals

getCompileTimeGlobals

clone

toString