com.google.template.soy.basetree

Class MixinParentNode<N extends Node>

java.lang.Object

com.google.template.soy.basetree.MixinParentNode<N>

public final class MixinParentNode<N extends Node>
extends Object

Mixin implementation of the parent-specific aspect of the ParentNode interface. Requires the master to be a ParentNode.

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

The parameter N represents the interface or class that is the superclass of all possible children for the master ParentNode. E.g. for a Soy parse tree node, N is usually SoyNode, but for SoyFileSetNode N is SoyFileNode, for SoyFileNode N is TemplateNode, etc; for a Soy expression parse tree, N is usually ExprNode.

Constructor Summary

Constructors

Constructor and Description
MixinParentNode(MixinParentNode<N> orig, ParentNode<N> newMaster, CopyState copyState) Copy constructor.
MixinParentNode(ParentNode<N> master)

Method Summary

Modifier and Type	Method and Description
void	addChild(int index, N child) Adds the given child at the given index (shifting existing children if necessary).
void	addChild(N child) Adds the given child.
void	addChildren(int index, List<? extends N> children) Adds the given children at the given index (shifting existing children if necessary).
void	addChildren(List<? extends N> children) Adds the given children.
void	appendSourceStringForChildren(StringBuilder sb) Appends the source strings for all the children to the given StringBuilder.
void	clearChildren() Clears the list of children.
N	getChild(int index) Gets the child at the given index.
int	getChildIndex(Node child) Finds the index of the given child.
List<N>	getChildren() Gets the list of children.
int	numChildren() Gets the number of children.
void	removeChild(int index) Removes the child at the given index.
void	removeChild(N child) Removes the given child.
void	replaceChild(int index, N newChild) Replaces the child at the given index with the given new child.
void	replaceChild(N currChild, N newChild) Replaces the given current child with the given new child.
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

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

Constructor Detail

MixinParentNode

public MixinParentNode(ParentNode<N> master)

Parameters:

master - The master node that delegates to this instance.

MixinParentNode

public MixinParentNode(MixinParentNode<N> orig,
                       ParentNode<N> newMaster,
                       CopyState copyState)

Copy constructor.

Parameters:

orig - The node to copy.

newMaster - The master node for the copy.

Method Detail

numChildren

public int numChildren()

Gets the number of children.

Returns:

The number of children.

getChild

public N getChild(int index)

Gets the child at the given index.

Parameters:

index - The index of the child to get.

Returns:

The child at the given index.

getChildIndex

public int getChildIndex(Node child)

Finds the index of the given child.

Parameters:

child - The child to find the index of.

Returns:

The index of the given child, or -1 if the given child is not a child of this node.

getChildren

public List<N> getChildren()

Gets the list of children.

Note: The returned list is not a copy. Please do not modify the list directly. Instead, use the other methods in this class that are intended for modifying children. Also, if you're iterating over the children list as you're modifying it, then you should first make a copy of the children list to iterate over, in order to avoid ConcurrentModificationException.

Returns:

The list of children.

addChild

public void addChild(N child)

Adds the given child.

Parameters:

child - The child to add.

addChild

public void addChild(int index,
                     N child)

Adds the given child at the given index (shifting existing children if necessary).

Parameters:

index - The index to add the child at.

child - The child to add.

removeChild

public void removeChild(int index)

Removes the child at the given index.

Parameters:

index - The index of the child to remove.

removeChild

public void removeChild(N child)

Removes the given child.

Parameters:

child - The child to remove.

replaceChild

public void replaceChild(int index,
                         N newChild)

Replaces the child at the given index with the given new child.

Parameters:

index - The index of the child to replace.

newChild - The new child.

replaceChild

public void replaceChild(N currChild,
                         N newChild)

Replaces the given current child with the given new child.

Parameters:

currChild - The current child to be replaced.

newChild - The new child.

clearChildren

public void clearChildren()

Clears the list of children.

addChildren

public void addChildren(List<? extends N> children)

Adds the given children.

Parameters:

children - The children to add.

addChildren

public void addChildren(int index,
                        List<? extends N> children)

Adds the given children at the given index (shifting existing children if necessary).

Parameters:

index - The index to add the children at.

children - The children to add.

appendSourceStringForChildren

public void appendSourceStringForChildren(StringBuilder sb)

Appends the source strings for all the children to the given StringBuilder.

Parameters:

sb - The StringBuilder to which to append the children's source strings.

toTreeString

public String toTreeString(int indent)

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.

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.