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.

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
FieldAccessNode(ExprNode base, String fieldName, boolean isNullSafe)

Method Summary

Modifier and Type	Method and Description
FieldAccessNode	clone() Copies this node.
boolean	equals(Object other)
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.
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

FieldAccessNode

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

Parameters:

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

fieldName - The name of the field.

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

clone

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