com.google.template.soy.exprtree

Class DataAccessNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FieldAccessNode, ItemAccessNode

public abstract class DataAccessNode
extends AbstractParentExprNode

Base class which represents access to a field or element of an aggregate value, such as an object or collection. Syntactically, data accesses are always suffix operators such as base.fieldName or 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

Modifier and Type	Field and Description
protected boolean	isNullSafe

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataAccessNode(DataAccessNode orig, CopyState copyState)
protected	DataAccessNode(ExprNode base, SourceLocation sourceLocation, boolean isNullSafe)

Method Summary

Modifier and Type	Method and Description
ExprNode	getBaseExprChild() Returns the base expression from which we're looking up the named field.
abstract String	getSourceStringSuffix() Returns the source string for the part of the expression that accesses the item - in other words, not including the base expression.
boolean	isNullSafe() Returns whether this field reference is null-safe.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

copy, getKind, getParent

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Field Detail

isNullSafe

protected final boolean isNullSafe

Constructor Detail

DataAccessNode

protected DataAccessNode(ExprNode base,
                         SourceLocation sourceLocation,
                         boolean isNullSafe)

Parameters:

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

sourceLocation - The node's source location.

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

DataAccessNode

protected DataAccessNode(DataAccessNode orig,
                         CopyState copyState)

Method Detail

getBaseExprChild

public ExprNode getBaseExprChild()

Returns the base expression from which we're looking up the named field.

isNullSafe

public boolean isNullSafe()

Returns whether this field reference is null-safe.

getSourceStringSuffix

public abstract 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.

toSourceString

public String toSourceString()

Description copied from interface: Node

Builds a Soy source string that could be the source for this node. Note that this is not the actual original source string, but a (SORT OF, NOT QUITE) canonical equivalent.

Note: Some nodes do not have a direct mapping to Soy source (such as nodes created during some optimization passes). Thus this method may not always be supported.

Returns:

A Soy string that could be the source for this node.