com.google.template.soy.exprtree

Class ItemAccessNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

com.google.template.soy.exprtree.AbstractParentExprNode

com.google.template.soy.exprtree.DataAccessNode

com.google.template.soy.exprtree.ItemAccessNode

All Implemented Interfaces:

Node, ParentNode<ExprNode>, ExprNode, ExprNode.ParentExprNode

public final class ItemAccessNode
extends DataAccessNode

Represents the bracket [] operation, which can either be used to access an array element by index, or a map value by key. Following the naming convention of Python, both array elements and map values are here referred to as "items". Note: This also includes the Soy syntax $foo.0, which is equivalent to $foo[0]. (The old dot-index syntax is supported for legacy reasons, but its use is discouraged in new templates.)

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.exprtree.ExprNode

ExprNode.ConstantNode, ExprNode.Kind, ExprNode.OperatorNode, ExprNode.ParentExprNode, ExprNode.PrimitiveNode

Field Summary

Fields inherited from class com.google.template.soy.exprtree.DataAccessNode

isNullSafe

Fields inherited from class com.google.template.soy.basetree.AbstractNode

SPACES

Constructor Summary

Constructors

Constructor and Description
ItemAccessNode(ExprNode base, ExprNode key, boolean isNullSafe, boolean isDotSyntax)

Method Summary

Modifier and Type	Method and Description
ItemAccessNode	clone() Copies this node.
boolean	equals(Object other)
ExprNode	getKeyExprChild() Returns the key expression.
ExprNode.Kind	getKind() Gets this node's kind (corresponding to this node's specific type).
String	getSourceStringSuffix() Returns the source string for the part of the expression that accesses the item - in other words, not including the base expression.
int	hashCode()

Methods inherited from class com.google.template.soy.exprtree.DataAccessNode

getBaseExprChild, isNullSafe, toSourceString

Methods inherited from class com.google.template.soy.exprtree.AbstractParentExprNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, getType, numChildren, removeChild, removeChild, replaceChild, replaceChild, setType, toTreeString

Methods inherited from class com.google.template.soy.exprtree.AbstractExprNode

getParent, getSourceLocation

Methods inherited from class com.google.template.soy.basetree.AbstractNode

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.exprtree.ExprNode

getParent

Methods inherited from interface com.google.template.soy.basetree.Node

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent

Constructor Detail

ItemAccessNode

public ItemAccessNode(ExprNode base,
                      ExprNode key,
                      boolean isNullSafe,
                      boolean isDotSyntax)

Parameters:

base - The base expression, that is a reference to the object containing the item.

key - An expression representing either an array index or a map key.

isNullSafe - If true, checks during evaluation whether the base expression is null and returns null instead of causing an invalid dereference.

isDotSyntax - If true, this node represents an expression of the form $foo.0, that is an integer after the dot.

Method Detail

getKind

public ExprNode.Kind getKind()

Description copied from interface: ExprNode

Gets this node's kind (corresponding to this node's specific type).

Returns:

This node's kind (corresponding to this node's specific type).

getKeyExprChild

public ExprNode getKeyExprChild()

Returns the key expression.

getSourceStringSuffix

public String getSourceStringSuffix()

Returns the source string for the part of the expression that accesses the item - in other words, not including the base expression. This is intended for use in reporting errors.

Specified by:

getSourceStringSuffix in class DataAccessNode

clone

public ItemAccessNode clone()

Description copied from interface: Node

Copies this node. The clone's parent pointer is set to null.

All clone() overrides should follow this contract:

• only leaf classes (in the class hierarchy) should have non-abstract clone methods
• all leaf classes should be final
• all leaf copy constructors should be private
• all clone methods should look exactly like:

  
      {@literal @}Override public T clone() {
        return new T(this);
      }
   

• all non-leaf copy constructors should be protected

NOTE: this means we do not ultimately delegate to Object.clone(), ever.

TODO(lukes): The usecases for a clone method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our clone() methods.

Specified by:

clone in interface Node

Specified by:

clone in interface ExprNode

Specified by:

clone in class AbstractExprNode

Returns:

A clone of this code.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object