com.google.template.soy.basetree

Class AbstractNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

All Implemented Interfaces:

Node

Direct Known Subclasses:

AbstractExprNode, AbstractSoyNode

public abstract class AbstractNode
extends Object
implements Node

Abstract implementation of a Node.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNode()
protected	AbstractNode(AbstractNode orig, CopyState copyState) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	couldHaveSyntaxVersionAtLeast(SyntaxVersion syntaxVersionCutoff) Returns false if we know that this node's syntax version must be lower than the given value.
boolean	equals(Object other)
<N extends Node> N	getNearestAncestor(Class<N> ancestorClass) Finds and returns this node's nearest ancestor of the given type.
ParentNode<?>	getParent() Gets this node's parent.
SyntaxVersionUpperBound	getSyntaxVersionUpperBound() Returns a pair (syntaxVersion, reasonStr), where the first item is the lowest known upper bound (exclusive!) for the syntax version of this node, and the second item is a user-friendly explanation of the reason for the bound.
boolean	hasAncestor(Class<? extends Node> ancestorClass) Determines whether this node has an ancestor of the given type.
int	hashCode()
void	maybeSetSyntaxVersionUpperBound(SyntaxVersionUpperBound newSyntaxVersionBound) Records a newly discovered upper bound for the syntax version of this node.
void	setParent(ParentNode<?> parent) Sets this node's parent.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy, getSourceLocation, toSourceString

Constructor Detail

AbstractNode

protected AbstractNode()

AbstractNode

protected AbstractNode(AbstractNode orig,
                       CopyState copyState)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

maybeSetSyntaxVersionUpperBound

public void maybeSetSyntaxVersionUpperBound(SyntaxVersionUpperBound newSyntaxVersionBound)

Description copied from interface: Node

Records a newly discovered upper bound for the syntax version of this node.

Specified by:

maybeSetSyntaxVersionUpperBound in interface Node

Parameters:

newSyntaxVersionBound - A newly discovered upper bound (exclusive!) for the syntax version of this node.

getSyntaxVersionUpperBound

@Nullable
public SyntaxVersionUpperBound getSyntaxVersionUpperBound()

Description copied from interface: Node

Returns a pair (syntaxVersion, reasonStr), where the first item is the lowest known upper bound (exclusive!) for the syntax version of this node, and the second item is a user-friendly explanation of the reason for the bound. For example: (V2_1, "Function hasData() is unnecessary and no longer allowed.") Returns null if there is no known upper bound on this node's syntax version.

Specified by:

getSyntaxVersionUpperBound in interface Node

couldHaveSyntaxVersionAtLeast

public boolean couldHaveSyntaxVersionAtLeast(SyntaxVersion syntaxVersionCutoff)

Description copied from interface: Node

Returns false if we know that this node's syntax version must be lower than the given value. Returns true otherwise (i.e. with what we know so far, this node could be the given syntax version or higher).

Specified by:

couldHaveSyntaxVersionAtLeast in interface Node

Parameters:

syntaxVersionCutoff - The syntax version cutoff to check.

setParent

public void setParent(ParentNode<?> parent)

Description copied from interface: Node

Sets this node's parent.

Specified by:

setParent in interface Node

Parameters:

parent - The parent node to set.

getParent

public ParentNode<?> getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Returns:

This node's parent.

hasAncestor

public boolean hasAncestor(Class<? extends Node> ancestorClass)

Description copied from interface: Node

Determines whether this node has an ancestor of the given type. The ancestor can be this node (i.e. doesn't have to be a proper ancestor).

Specified by:

hasAncestor in interface Node

Parameters:

ancestorClass - The type of ancestor to look for.

Returns:

True if this node has an ancestor of the given type.

getNearestAncestor

public <N extends Node> N getNearestAncestor(Class<N> ancestorClass)

Description copied from interface: Node

Finds and returns this node's nearest ancestor of the given type. The ancestor can be this node (i.e. doesn't have to be a proper ancestor).

Specified by:

getNearestAncestor in interface Node

Type Parameters:

N - The type of ancestor to retrieve.

Parameters:

ancestorClass - The class object for the type of ancestor to retrieve.

Returns:

This node's nearest ancestor of the given type, or null if none.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object