com.google.template.soy.exprtree

Class AbstractExprNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.exprtree.AbstractExprNode

All Implemented Interfaces:

Node, ExprNode

Direct Known Subclasses:

AbstractParentExprNode, BooleanNode, FloatNode, GlobalNode, IntegerNode, NullNode, StringNode, VarNode, VarRefNode

public abstract class AbstractExprNode
extends AbstractNode
implements ExprNode

Abstract implementation of an ExprNode.

Important: Do not use outside of Soy code (treat as superpackage-private).

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.basetree.AbstractNode

SPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExprNode(AbstractExprNode orig) Copy constructor.
protected	AbstractExprNode(SourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
abstract ExprNode	clone() Copies this node.
ExprNode.ParentExprNode	getParent() Gets this node's parent.
SourceLocation	getSourceLocation() TODO(user): The quality of source locations in expression nodes is not great.

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

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getKind, getType

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toSourceString, toTreeString

Constructor Detail

AbstractExprNode

protected AbstractExprNode(SourceLocation sourceLocation)

AbstractExprNode

protected AbstractExprNode(AbstractExprNode orig)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

getParent

public ExprNode.ParentExprNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface ExprNode

Overrides:

getParent in class AbstractNode

Returns:

This node's parent.

getSourceLocation

public SourceLocation getSourceLocation()

TODO(user): The quality of source locations in expression nodes is not great. These source locations are computed by the expression parser, and they depend on the parentSourceLocation that is passed in to the ExpressionParser constructor. The quality of these parentSourceLocations varies. Callers often perform regex-based munging of expression texts before passing them to the ExpressionParser (example: CallParamNode.Builder#parseCommandTextHelper), which implies that the parentSourceLocation passed along with the munged text is inaccurate.

Until this is fixed, source locations obtained from expression nodes should be treated as best-effort only.

Specified by:

getSourceLocation in interface Node

clone

public abstract ExprNode 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 AbstractNode

Returns:

A clone of this code.