com.google.template.soy.exprtree

Class FieldAccessNode

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

All Implemented Interfaces:

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

public final class FieldAccessNode
extends DataAccessNode

Reference to a named field.

The source location of this node is the location of the .field 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
FieldAccessNode(ExprNode base, String fieldName, SourceLocation location, boolean isNullSafe)

Method Summary

Modifier and Type	Method and Description
FieldAccessNode	copy(CopyState copyState) See Node.copy(CopyState) for a description of the copy contract.
String	getFieldName() Returns the field name.
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

FieldAccessNode

public FieldAccessNode(ExprNode base,
                       String fieldName,
                       SourceLocation location,
                       boolean isNullSafe)

Parameters:

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

fieldName - The name of the field.

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

getFieldName

public String getFieldName()

Returns the field name.

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