MsgFallbackGroupNode (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNode
- - com.google.template.soy.soytree.AbstractSoyNode
  - - com.google.template.soy.soytree.AbstractParentSoyNode<MsgNode>
    - - com.google.template.soy.soytree.MsgFallbackGroupNode

All Implemented Interfaces:

Node, ParentNode<MsgNode>, SoyNode, SoyNode.ParentSoyNode<MsgNode>, SoyNode.SplitLevelTopNode<MsgNode>, SoyNode.StandaloneNode, SoyNode.StatementNode
```
public final class MsgFallbackGroupNode
extends AbstractParentSoyNode<MsgNode>
implements SoyNode.StandaloneNode, SoyNode.SplitLevelTopNode<MsgNode>, SoyNode.StatementNode
```
Represents one message or a pair of message and fallback message.
Only one fallbackmsg is allowed by the parser. com.google.template.soy.soyparse.TemplateParserTest.java#testRecognizeCommands TODO(user): fix the grammar.
Important: Do not use outside of Soy code (treat as superpackage-private).
All children are MsgNodes. And conversely, all MsgNodes must be children of MsgFallbackGroupNodes through parsing and middleend passes (backends may have their own special structure for messages).

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

MsgFallbackGroupNode(int id, SourceLocation sourceLocation)

Constructors
Constructor and Description
`MsgFallbackGroupNode(int id, SourceLocation sourceLocation)`

Method Summary

Methods
Modifier and Type	Method and Description
`MsgFallbackGroupNode`	`copy(CopyState copyState)` Copies this node.
`com.google.common.collect.ImmutableList<String>`	`getEscapingDirectiveNames()` Returns the escaping directives, applied from left to right.
`MsgNode`	`getFallbackMsg()`
`HtmlContext`	`getHtmlContext()` Gets the HTML context (typically tag, attribute value, HTML PCDATA, or plain text) which this node appears in.
`SoyNode.Kind`	`getKind()` Returns this node's kind (corresponding to this node's specific type).
`MsgNode`	`getMsg()`
`SoyNode.BlockNode`	`getParent()` Gets this node's parent.
`boolean`	`hasFallbackMsg()`
`PrintNode`	`makePrintNode(IdGenerator nodeIdGen, VarDefn var)` Creates a print node that corresponds to this node, for tree rewriting.
`void`	`setEscapingDirectiveNames(com.google.common.collect.ImmutableList<String> escapingDirectiveNames)` Sets the inferred escaping directives from the contextual engine.
`void`	`setHtmlContext(HtmlContext value)`
`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.basetree.ParentNode
addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

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
  - MsgFallbackGroupNode
```
public MsgFallbackGroupNode(int id,
                    SourceLocation sourceLocation)
```
    Parameters:
    id - The id for this node.
    sourceLocation - The node's source location.
- Method Detail
  - getHtmlContext
```
public HtmlContext getHtmlContext()
```
    Gets the HTML context (typically tag, attribute value, HTML PCDATA, or plain text) which this node appears in. This affects how the node is escaped (for traditional backends) or how it's passed to incremental DOM APIs.
  - setHtmlContext
```
public void setHtmlContext(HtmlContext value)
```
  - makePrintNode
```
public PrintNode makePrintNode(IdGenerator nodeIdGen,
                      VarDefn var)
```
    Creates a print node that corresponds to this node, for tree rewriting.
  - 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
  - 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.
  - hasFallbackMsg
```
public boolean hasFallbackMsg()
```
  - getMsg
```
public MsgNode getMsg()
```
  - getFallbackMsg
```
public MsgNode getFallbackMsg()
```
  - copy
```
public MsgFallbackGroupNode 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.
  - setEscapingDirectiveNames
```
public void setEscapingDirectiveNames(com.google.common.collect.ImmutableList<String> escapingDirectiveNames)
```
    Sets the inferred escaping directives from the contextual engine.
  - getEscapingDirectiveNames
```
public com.google.common.collect.ImmutableList<String> getEscapingDirectiveNames()
```
    Returns the escaping directives, applied from left to right.
    It is an error to call this before the contextual rewriter has been run.

Class MsgFallbackGroupNode

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.basetree.ParentNode

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

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

Constructor Detail

MsgFallbackGroupNode

Method Detail

getHtmlContext

setHtmlContext

makePrintNode

getKind

toSourceString

getParent

hasFallbackMsg

getMsg

getFallbackMsg

copy

setEscapingDirectiveNames

getEscapingDirectiveNames