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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SPACES Just spaces.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract Node	clone() Copies this node.
boolean	couldHaveSyntaxVersionAtLeast(SyntaxVersion syntaxVersionCutoff) Returns false if we know that this node's syntax version must be lower than the given value.
<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.
SyntaxVersionBound	getSyntaxVersionBound() 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.
void	maybeSetSyntaxVersionBound(SyntaxVersionBound 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()
String	toTreeString(int indent) Builds a string that visually shows the subtree rooted at this node (for debugging).

Methods inherited from class java.lang.Object

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

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

getSourceLocation, toSourceString

Field Detail

SPACES

protected static final String SPACES

Just spaces.

See Also:

Constant Field Values

Constructor Detail

AbstractNode

protected AbstractNode()

AbstractNode

protected AbstractNode(AbstractNode orig)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

maybeSetSyntaxVersionBound

public void maybeSetSyntaxVersionBound(SyntaxVersionBound newSyntaxVersionBound)

Description copied from interface: Node

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

Specified by:

maybeSetSyntaxVersionBound in interface Node

Parameters:

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

getSyntaxVersionBound

@Nullable
public SyntaxVersionBound getSyntaxVersionBound()

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:

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

toString

public String toString()

Overrides:

toString in class Object

toTreeString

public String toTreeString(int indent)

Description copied from interface: Node

Builds a string that visually shows the subtree rooted at this node (for debugging). Each line of the string will be indented by the given indentation amount. You should pass an indentation of 0 unless this method is being called as part of building a larger tree string.

Specified by:

toTreeString in interface Node

Parameters:

indent - The indentation for each line of the tree string (usually pass 0).

Returns:

A string that visually shows the subtree rooted at this node.

clone

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

Overrides:

clone in class Object

Returns:

A clone of this code.