com.google.template.soy.soytree

Class AbstractSoyNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

All Implemented Interfaces:

Node, SoyNode

Direct Known Subclasses:

AbstractCommandNode, AbstractParentSoyNode, GoogMsgRefNode, MsgPluralRemainderNode, PrintDirectiveNode, RawTextNode

public abstract class AbstractSoyNode
extends AbstractNode
implements SoyNode

Abstract implementation of a SoyNode.

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.soytree.SoyNode

SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.Kind, SoyNode.LocalVarBlockNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.LoopNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Field Summary

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

SPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSoyNode(AbstractSoyNode orig) Copy constructor.
protected	AbstractSoyNode(int id)

Method Summary

Modifier and Type	Method and Description
abstract SoyNode	clone() Copies this node.
int	getId() Returns this node's id.
SoyNode.ParentSoyNode<?>	getParent() Gets this node's parent.
SourceLocation	getSourceLocation() The location in the file from which it was parsed or derived.
void	setId(int id) Sets this node's id.
void	setSourceLocation(SourceLocation srcLoc) Sets the source location (file path and line number) for this node.
String	toString()

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, 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.soytree.SoyNode

getKind

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

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

Constructor Detail

AbstractSoyNode

protected AbstractSoyNode(int id)

Parameters:

id - The id for this node.

AbstractSoyNode

protected AbstractSoyNode(AbstractSoyNode orig)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

setId

public void setId(int id)

Description copied from interface: SoyNode

Sets this node's id.

Important: The id should already be set during construction, so this method should only be used during cloning.

Specified by:

setId in interface SoyNode

Parameters:

id - The new id for this node.

getId

public int getId()

Description copied from interface: SoyNode

Returns this node's id.

Specified by:

getId in interface SoyNode

getSourceLocation

public SourceLocation getSourceLocation()

The location in the file from which it was parsed or derived.

Specified by:

getSourceLocation in interface SoyNode

setSourceLocation

public void setSourceLocation(SourceLocation srcLoc)

Description copied from interface: SoyNode

Sets the source location (file path and line number) for this node.

Specified by:

setSourceLocation in interface SoyNode

Parameters:

srcLoc - The source location for this node.

getParent

public SoyNode.ParentSoyNode<?> getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Overrides:

getParent in class AbstractNode

Returns:

This node's parent.

clone

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

Specified by:

clone in class AbstractNode

Returns:

A clone of this code.

toString

public String toString()

Overrides:

toString in class AbstractNode