MsgPlaceholderNode (Closure Templates)

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

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>, SoyNode.StandaloneNode
```
public final class MsgPlaceholderNode
extends AbstractParentSoyNode<SoyNode.StandaloneNode>
implements SoyNode.MsgSubstUnitNode
```
A node that is the direct child of a MsgBlockNode and will turn into a placeholder.
Important: Do not use outside of Soy code (treat as superpackage-private).
Note: there is no guarantee that the child of this node is a SoyNode.MsgPlaceholderInitialNode, the optimizer may inline and replace constant placeholders as RawTextNodes.

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
Constructor and Description

MsgPlaceholderNode(int id, SoyNode.MsgPlaceholderInitialNode initialNode)

Constructors
Constructor and Description
`MsgPlaceholderNode(int id, SoyNode.MsgPlaceholderInitialNode initialNode)`

Method Summary

Methods
Modifier and Type	Method and Description
`MsgPlaceholderNode`	`copy(CopyState copyState)` Copies this node.
`String`	`getBaseVarName()` Returns the base placeholder name (what the translator sees).
`SoyNode.Kind`	`getKind()` Returns this node's kind (corresponding to this node's specific type).
`SoyNode.MsgBlockNode`	`getParent()` Gets this node's parent.
`boolean`	`shouldUseSameVarNameAs(SoyNode.MsgSubstUnitNode other)` Returns whether this node and the given other node are the same, such that they should be represented by the same placeholder.
`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

- Constructor Detail
  - MsgPlaceholderNode
```
public MsgPlaceholderNode(int id,
                  SoyNode.MsgPlaceholderInitialNode initialNode)
```
    Parameters:
    id - The id for this node.
    initialNode - Will be set as the only child of this node being created. The child is the node that represents the content of this placeholder. It is called the initial node because it may be modified/replaced later by compiler passes.
- Method Detail
  - 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
  - getBaseVarName
```
public String getBaseVarName()
```
    Returns the base placeholder name (what the translator sees).
    
    Specified by:
    
    getBaseVarName in interface SoyNode.MsgSubstUnitNode
  - shouldUseSameVarNameAs
```
public boolean shouldUseSameVarNameAs(SoyNode.MsgSubstUnitNode other)
```
    Returns whether this node and the given other node are the same, such that they should be represented by the same placeholder.
    
    Specified by:
    
    shouldUseSameVarNameAs in interface SoyNode.MsgSubstUnitNode
    
    Parameters:
    other - The other substitution unit to check against.
  - 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.MsgBlockNode 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.MsgSubstUnitNode
    
    Specified by:
    
    getParent in interface SoyNode.StandaloneNode
    
    Overrides:
    
    getParent in class AbstractSoyNode
    
    Returns:
    This node's parent.
  - copy
```
public MsgPlaceholderNode 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.

Class MsgPlaceholderNode

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

MsgPlaceholderNode

Method Detail

getKind

getBaseVarName

shouldUseSameVarNameAs

toSourceString

getParent

copy