com.google.template.soy.jbcsrc.restricted

Enum Expression.Feature

java.lang.Object

java.lang.Enum<Expression.Feature>

com.google.template.soy.jbcsrc.restricted.Expression.Feature

All Implemented Interfaces:

Serializable, Comparable<Expression.Feature>

Enclosing class:

Expression

public static enum Expression.Feature
extends Enum<Expression.Feature>

Expression features track additional metadata for expressions.

Features should be defined such that not setting a feature on an expression is a safe default. That way if they get accidentally dropped in a transformation we simply generate less efficient code, not incorrect code.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHEAP The expression is 'cheap'.
NON_NULLABLE The expression is guaranteed to not return null.

Method Summary

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

NON_NULLABLE

public static final Expression.Feature NON_NULLABLE

The expression is guaranteed to not return null.

CHEAP

public static final Expression.Feature CHEAP

The expression is 'cheap'. As a rule of thumb, if it involves allocation, it is not cheap.

Cheapness is useful when deciding if it would be reasonable to evaluate an expression more than once if the alternative is generating additional fields and save/restore code.

Method Detail

values

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

Returns:

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

valueOf

public static Expression.Feature 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