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".

The source location of this node is the location of the [<expr>] and doesn't include the base expression.

Nested Class Summary

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

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

Field Summary

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

isNullSafe

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ItemAccessNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
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.

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, clearChildren, getChild, getChildIndex, getChildren, getType, numChildren, removeChild, removeChild, replaceChild, replaceChild, setType

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

getParent, getSourceLocation

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

couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent, toString

Methods inherited from class java.lang.Object

clone, 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, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

ItemAccessNode

public ItemAccessNode(ExprNode base,
                      ExprNode key,
                      SourceLocation location,
                      boolean isNullSafe)

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.

location - The location of the access expression

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

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

copy

public ItemAccessNode copy(CopyState copyState)

Description copied from interface: ExprNode

See Node.copy(CopyState) for a description of the copy contract.

Returns:

A clone of this code.