com.google.template.soy.basetree

Enum SyntaxVersion

java.lang.Object

java.lang.Enum<SyntaxVersion>

com.google.template.soy.basetree.SyntaxVersion

All Implemented Interfaces:

Serializable, Comparable<SyntaxVersion>

public enum SyntaxVersion
extends Enum<SyntaxVersion>

Enum for the syntax version.

Important: Do not use outside of Soy code (treat as superpackage-private).

Enum Constant Summary

Enum Constants

Enum Constant and Description
V1_0 V1.0 allows these legacy deprecated items: No 'namespace' declaration in Soy file.
V2_0 V2.0 is the syntax that has historically been enforced by the Soy compiler.
V2_3 Syntax that causes V2.3+ to be inferred: Usage of template header @param decls (as opposed to SoyDoc @param decls).
V2_4 Syntax that causes V2.4+ to be inferred: Usage of template header @inject decls (as opposed to $ij variables).
V9_9 For internal use only.

Field Summary

Fields

Modifier and Type	Field and Description
String	name The string name.
int	num The number for ordering.

Method Summary

Modifier and Type	Method and Description
static SyntaxVersion	forName(String name)
String	toString()
static SyntaxVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static SyntaxVersion[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

V1_0

public static final SyntaxVersion V1_0

V1.0 allows these legacy deprecated items:

• No 'namespace' declaration in Soy file.
• Some prevalent forms of incorrect param declarations in template SoyDoc.
• Template name that isn't a dot followed by an identifier (i.e. relative to namespace).
• Expressions that cannot be parsed as a Soy V2 expression.

V2_0

public static final SyntaxVersion V2_0

V2.0 is the syntax that has historically been enforced by the Soy compiler.

V2_3

public static final SyntaxVersion V2_3

Syntax that causes V2.3+ to be inferred:

• Usage of template header @param decls (as opposed to SoyDoc @param decls).

Behavior changes if V2.3+ is declared (not inferred):

• Logical operators ('and', 'or') output type bool instead of unknown.

Checks:

• Type bool can no longer be used in nonbool contexts.
• Type bool can no longer be printed.

V2_4

public static final SyntaxVersion V2_4

Syntax that causes V2.4+ to be inferred:

• Usage of template header @inject decls (as opposed to $ij variables).

V9_9

public static final SyntaxVersion V9_9

For internal use only. Represents a nonexistent future version.

Field Detail

name

public final String name

The string name.

num

public final int num

The number for ordering.

Method Detail

values

public static SyntaxVersion[] 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 (SyntaxVersion c : SyntaxVersion.values())
    System.out.println(c);

Returns:

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

valueOf

public static SyntaxVersion 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

forName

public static SyntaxVersion forName(String name)

toString

public String toString()

Overrides:

toString in class Enum<SyntaxVersion>