com.google.template.soy.soytree

Enum AutoescapeMode

java.lang.Object

java.lang.Enum<AutoescapeMode>

com.google.template.soy.soytree.AutoescapeMode

All Implemented Interfaces:

Serializable, Comparable<AutoescapeMode>

public enum AutoescapeMode
extends Enum<AutoescapeMode>

Specifies how the outputs of {print} commands that lack escaping directives are encoded.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTEXTUAL Contextual auto-escaping is on for the template so directiveless prints will be escaped based on the surrounding context.
NONCONTEXTUAL Auto-escaping is on for the template so directiveless prints will be HTML escaped.
STRICT Strict form of contextual autoescaping in which no autoescape-cancelling print directives nor calls to non-strict templates are allowed.

Method Summary

Modifier and Type	Method and Description
String	getAttributeValue() Returns a form of this attribute's name suitable for use in a template attribute.
static Set<String>	getAttributeValues() The set created by element-wise application of getAttributeValue() to all modes.
static AutoescapeMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AutoescapeMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONCONTEXTUAL

public static final AutoescapeMode NONCONTEXTUAL

Auto-escaping is on for the template so directiveless prints will be HTML escaped.

CONTEXTUAL

public static final AutoescapeMode CONTEXTUAL

Contextual auto-escaping is on for the template so directiveless prints will be escaped based on the surrounding context.

STRICT

public static final AutoescapeMode STRICT

Strict form of contextual autoescaping in which no autoescape-cancelling print directives nor calls to non-strict templates are allowed.

Method Detail

values

public static AutoescapeMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AutoescapeMode c : AutoescapeMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AutoescapeMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getAttributeValue

public String getAttributeValue()

Returns a form of this attribute's name suitable for use in a template attribute.

getAttributeValues

public static Set<String> getAttributeValues()

The set created by element-wise application of getAttributeValue() to all modes.