com.google.template.soy.basetree

Interface ParentNode<N extends Node>

All Superinterfaces:

Node

All Known Subinterfaces:

ExprNode.OperatorNode, ExprNode.ParentExprNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.ConditionalBlockNode, SoyNode.LocalVarBlockNode, SoyNode.MsgBlockNode, SoyNode.ParentSoyNode<N>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N>

All Known Implementing Classes:

AbstractOperatorNode, AbstractParentExprNode, AbstractParentSoyNode, CallBasicNode, CallDelegateNode, CallNode, CallParamContentNode, CaseOrDefaultNode, DataAccessNode, ExprRootNode, FieldAccessNode, ForIfemptyNode, ForNode, ForNonemptyNode, FunctionNode, HtmlAttributeNode, HtmlAttributeValueNode, HtmlCloseTagNode, HtmlCommentNode, HtmlOpenTagNode, HtmlTagNode, IfCondNode, IfElseNode, IfNode, ItemAccessNode, LegacyObjectMapLiteralNode, LetContentNode, ListLiteralNode, LogNode, MapLiteralNode, MsgFallbackGroupNode, MsgHtmlTagNode, MsgNode, MsgPlaceholderNode, MsgPluralCaseNode, MsgPluralDefaultNode, MsgPluralNode, MsgSelectCaseNode, MsgSelectDefaultNode, MsgSelectNode, OperatorNodes.AndOpNode, OperatorNodes.ConditionalOpNode, OperatorNodes.DivideByOpNode, OperatorNodes.EqualOpNode, OperatorNodes.GreaterThanOpNode, OperatorNodes.GreaterThanOrEqualOpNode, OperatorNodes.LessThanOpNode, OperatorNodes.LessThanOrEqualOpNode, OperatorNodes.MinusOpNode, OperatorNodes.ModOpNode, OperatorNodes.NegativeOpNode, OperatorNodes.NotEqualOpNode, OperatorNodes.NotOpNode, OperatorNodes.NullCoalescingOpNode, OperatorNodes.OrOpNode, OperatorNodes.PlusOpNode, OperatorNodes.TimesOpNode, PrintNode, ProtoInitNode, SoyFileNode, SoyFileSetNode, SwitchCaseNode, SwitchDefaultNode, SwitchNode, TemplateBasicNode, TemplateDelegateNode, TemplateNode, VeLogNode

public interface ParentNode<N extends Node>
extends Node

A node that may have children in the parse tree.

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

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.

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

copy, couldHaveSyntaxVersionAtLeast, getNearestAncestor, getParent, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent, toSourceString

Method Detail

numChildren

int numChildren()

Gets the number of children.

Returns:

The number of children.

getChild

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

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

List<N> getChildren()

Gets the list of children.

Note: The returned list may not be 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

void addChild(N child)

Adds the given child.

Parameters:

child - The child to add.

addChild

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

void removeChild(int index)

Removes the child at the given index.

Parameters:

index - The index of the child to remove.

removeChild

void removeChild(N child)

Removes the given child.

Parameters:

child - The child to remove.

replaceChild

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

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

void clearChildren()

Clears the list of children.

addChildren

void addChildren(List<? extends N> children)

Adds the given children.

Parameters:

children - The children to add.

addChildren

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

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.