com.google.template.soy.soytree

Class MsgHtmlTagNode

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

All Implemented Interfaces:

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

public final class MsgHtmlTagNode
extends AbstractParentSoyNode<SoyNode.StandaloneNode>
implements SoyNode.MsgPlaceholderInitialNode

Node representing an HTML tag within a msg statement/block.

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

Method Summary

Modifier and Type	Method and Description
MsgHtmlTagNode	copy(CopyState copyState) Copies this node.
static MsgHtmlTagNode	fromNode(int id, HtmlTagNode tagNode, ErrorReporter errorReporter) Creates a MsgHtmlTagNode from a HtmlTagNode.
String	genBasePhName() Generates the base placeholder name for this node.
Object	genSamenessKey() Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	getLcTagName() Returns the lower-case HTML tag name (includes '/' for end tags).
SoyNode.BlockNode	getParent() Gets this node's parent.
String	getUserSuppliedPhExample() Gets the user-supplied placeholder example, or null if not supplied or not applicable.
String	getUserSuppliedPhName() Gets the user-supplied placeholder name, or null if not supplied or not applicable.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

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

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

Method Detail

fromNode

public static MsgHtmlTagNode fromNode(int id,
                                      HtmlTagNode tagNode,
                                      ErrorReporter errorReporter)

Creates a MsgHtmlTagNode from a HtmlTagNode.

If the node contains a phname attribute, it will be removed from the node and used as the placeholder name, it will _not_ be rendered.

getKind

public SoyNode.Kind getKind()

Description copied from interface: SoyNode

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

Specified by:

getKind in interface SoyNode

getLcTagName

public String getLcTagName()

Returns the lower-case HTML tag name (includes '/' for end tags).

getUserSuppliedPhName

@Nullable
public String getUserSuppliedPhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Gets the user-supplied placeholder name, or null if not supplied or not applicable. Note that this raw name can be any identifier (not necessarily in upper-underscore format).

Specified by:

getUserSuppliedPhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The user-supplied placeholder name, or null if not supplied or not applicable.

getUserSuppliedPhExample

@Nullable
public String getUserSuppliedPhExample()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Gets the user-supplied placeholder example, or null if not supplied or not applicable.

Specified by:

getUserSuppliedPhExample in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The user-supplied placeholder example, or null if not supplied or not applicable.

genBasePhName

public String genBasePhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the base placeholder name for this node.

Specified by:

genBasePhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The base placeholder name for this node.

genSamenessKey

public Object genSamenessKey()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.

Specified by:

genSamenessKey in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The key object for determining whether this node and another node should be represented by the same placeholder.

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.

Specified by:

toSourceString in interface Node

Returns:

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

getParent

public SoyNode.BlockNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Specified by:

getParent in interface SoyNode.StandaloneNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

copy

public MsgHtmlTagNode copy(CopyState copyState)

Description copied from interface: SoyNode

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

The copied nodes will have the same ids as the original nodes. If you need to copy a subtree with new ids assigned to the copied nodes, use SoyTreeUtils.cloneWithNewIds(T, com.google.template.soy.base.internal.IdGenerator).

Specified by:

copy in interface Node

Specified by:

copy in interface SoyNode

Returns:

A clone of this code.