Operator (Closure Templates)

java.lang.Object
- java.lang.Enum<Operator>
- - com.google.template.soy.exprtree.Operator

All Implemented Interfaces:

Serializable, Comparable<Operator>
```
public enum Operator
extends Enum<Operator>
```
Enum of Soy expression operators.
Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Operator.Associativity` Enum for an operator's associativity.
`static class`	`Operator.Operand` A syntax element for an operand.
`static class`	`Operator.Spacer` A syntax element for a space character.
`static interface`	`Operator.SyntaxElement` Represents a syntax element (used in a syntax specification for an operator).
`static class`	`Operator.Token` A syntax element for a token.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AND`
`CONDITIONAL`
`DIVIDE_BY`
`EQUAL`
`GREATER_THAN`
`GREATER_THAN_OR_EQUAL`
`LESS_THAN`
`LESS_THAN_OR_EQUAL`
`MINUS`
`MOD`
`NEGATIVE`
`NOT`
`NOT_EQUAL`
`NULL_COALESCING`
`OR`
`PLUS`
`TIMES`

Method Summary

Methods
Modifier and Type	Method and Description
`ExprNode.OperatorNode`	`createNode(ExprNode... children)` Creates a node representing this operator, with the given children.
`abstract ExprNode.OperatorNode`	`createNode(SourceLocation location)` Creates a node representing this operator.
`Operator.Associativity`	`getAssociativity()` Returns this operator's associativity.
`String`	`getDescription()` Returns a short description of this operator (usually just the token string).
`int`	`getNumOperands()` Returns the number of operands that this operator takes.
`int`	`getPrecedence()` Returns this operator's precedence level.
`List<Operator.SyntaxElement>`	`getSyntax()` Returns the canonical syntax for this operator, including spacing.
`String`	`getTokenString()` Returns this operator's token.
`static Operator`	`of(String tokenString, int numOperands)` Fetches an Operator given the pair (tokenString, numOperands).
`static Operator`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Operator[]`	`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
  - NEGATIVE
```
public static final Operator NEGATIVE
```
  - NOT
```
public static final Operator NOT
```
  - TIMES
```
public static final Operator TIMES
```
  - DIVIDE_BY
```
public static final Operator DIVIDE_BY
```
  - MOD
```
public static final Operator MOD
```
  - PLUS
```
public static final Operator PLUS
```
  - MINUS
```
public static final Operator MINUS
```
  - LESS_THAN
```
public static final Operator LESS_THAN
```
  - GREATER_THAN
```
public static final Operator GREATER_THAN
```
  - LESS_THAN_OR_EQUAL
```
public static final Operator LESS_THAN_OR_EQUAL
```
  - GREATER_THAN_OR_EQUAL
```
public static final Operator GREATER_THAN_OR_EQUAL
```
  - EQUAL
```
public static final Operator EQUAL
```
  - NOT_EQUAL
```
public static final Operator NOT_EQUAL
```
  - AND
```
public static final Operator AND
```
  - OR
```
public static final Operator OR
```
  - NULL_COALESCING
```
public static final Operator NULL_COALESCING
```
  - CONDITIONAL
```
public static final Operator CONDITIONAL
```
- Method Detail
  - values
```
public static Operator[] 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 (Operator c : Operator.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Operator 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
  - of
```
public static Operator of(String tokenString,
          int numOperands)
```
    Fetches an Operator given the pair (tokenString, numOperands).
    
    Parameters:
    tokenString - A string listing the operator token. If multiple tokens (e.g. the ternary conditional operator), separate them using a space.
    numOperands - The number of operands this operator takes.
    
    Returns:
    The matching Operator object.
    
    Throws:
    
    IllegalArgumentException - If there is no Soy operator matching the given data.
  - getSyntax
```
public List<Operator.SyntaxElement> getSyntax()
```
    Returns the canonical syntax for this operator, including spacing.
  - getTokenString
```
public String getTokenString()
```
    Returns this operator's token. Multiple tokens (e.g. the ternary conditional operator) are separated using a space.
  - getNumOperands
```
public int getNumOperands()
```
    Returns the number of operands that this operator takes.
  - getPrecedence
```
public int getPrecedence()
```
    Returns this operator's precedence level.
  - getAssociativity
```
public Operator.Associativity getAssociativity()
```
    Returns this operator's associativity.
  - getDescription
```
public String getDescription()
```
    Returns a short description of this operator (usually just the token string).
  - createNode
```
public abstract ExprNode.OperatorNode createNode(SourceLocation location)
```
    Creates a node representing this operator.
  - createNode
```
public final ExprNode.OperatorNode createNode(ExprNode... children)
```
    Creates a node representing this operator, with the given children.

Enum Operator

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NEGATIVE

NOT

TIMES

DIVIDE_BY

MOD

PLUS

MINUS

LESS_THAN

GREATER_THAN

LESS_THAN_OR_EQUAL

GREATER_THAN_OR_EQUAL

EQUAL

NOT_EQUAL

AND

OR

NULL_COALESCING

CONDITIONAL

Method Detail

values

valueOf

of

getSyntax

getTokenString

getNumOperands

getPrecedence

getAssociativity

getDescription

createNode

createNode