com.google.template.soy.soytree

Class HtmlOpenTagNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractParentSoyNode<SoyNode.StandaloneNode>

com.google.template.soy.soytree.HtmlTagNode

com.google.template.soy.soytree.HtmlOpenTagNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>, SoyNode.StandaloneNode

public final class HtmlOpenTagNode
extends HtmlTagNode

An HtmlOpenTagNode represents an opening html tag.

For example, <{$tag} {$attr1} foo="{$attrvalue}" /> .

The first child is guaranteed to be the tag name, any after that are guaranteed to be in attribute context. There is always at least one child.

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.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Constructor Summary

Constructors

Constructor and Description
HtmlOpenTagNode(int id, TagName tagName, SourceLocation sourceLocation, boolean selfClosing)

Method Summary

Modifier and Type	Method and Description
HtmlOpenTagNode	copy(CopyState copyState) Copies this node.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
boolean	isSelfClosing()
String	toSourceString() Builds a Soy source string that could be the source for this node.

Methods inherited from class com.google.template.soy.soytree.HtmlTagNode

getDirectAttributeNamed, getParent, getTagName

Methods inherited from class com.google.template.soy.soytree.AbstractParentSoyNode

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNode

getId, getSourceLocation, setId, toString

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

couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.template.soy.soytree.SoyNode

getId, setId

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

HtmlOpenTagNode

public HtmlOpenTagNode(int id,
                       TagName tagName,
                       SourceLocation sourceLocation,
                       boolean selfClosing)

Method Detail

getKind

public SoyNode.Kind getKind()

Description copied from interface: SoyNode

Returns this node's kind (corresponding to this node's specific type).

isSelfClosing

public boolean isSelfClosing()

copy

public HtmlOpenTagNode copy(CopyState copyState)

Description copied from interface: Node

Copies this node. The copy's parent pointer is set to null.

All copy() 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 copy(CopyState copyState) {
     return new T(this, copyState);
   }
   

• all non-leaf copy constructors should be protected

TODO(lukes): The usecases for a copy method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our copy() methods.

Don't clone nodes unless you know what you're doing. The Soy AST is not actually a tree (it contains back edges from variables to their definitions), and naively copying nodes can result in pointers into stale ASTs

Returns:

A clone of this code.

toSourceString

public String toSourceString()

Description copied from interface: Node

Builds a Soy source string that could be the source for this node. Note that this is not the actual original source string, but a (SORT OF, NOT QUITE) canonical equivalent.

Note: Some nodes do not have a direct mapping to Soy source (such as nodes created during some optimization passes). Thus this method may not always be supported.

Returns:

A Soy string that could be the source for this node.