com.google.template.soy.soytree

Class MsgPluralRemainderNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.MsgPluralRemainderNode

All Implemented Interfaces:

Node, SoyNode, SoyNode.MsgSubstUnitNode, SoyNode.StandaloneNode

public final class MsgPluralRemainderNode
extends AbstractSoyNode
implements SoyNode.MsgSubstUnitNode

Node representing a 'remainder' section in a 'plural' 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.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
MsgPluralRemainderNode(PrintNode origPrintNode)

Method Summary

Modifier and Type	Method and Description
MsgPluralRemainderNode	clone() Copies this node.
String	getBaseVarName() Returns the base var name for this substitution unit.
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 substitution unit should use the same var name as another substitution unit.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, 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, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

Constructor Detail

MsgPluralRemainderNode

public MsgPluralRemainderNode(PrintNode origPrintNode)

Parameters:

origPrintNode - The print node containing "remainder".

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()

Description copied from interface: SoyNode.MsgSubstUnitNode

Returns the base var name for this substitution unit. (For a placeholder, this is the base placeholder name.)

Note: This isn't quite correct semantically. It's conceivable that a new type of substitution unit in the future could have multiple vars. But until that happens, this simpler model is sufficient.

Specified by:

getBaseVarName in interface SoyNode.MsgSubstUnitNode

shouldUseSameVarNameAs

public boolean shouldUseSameVarNameAs(SoyNode.MsgSubstUnitNode other)

Description copied from interface: SoyNode.MsgSubstUnitNode

Returns whether this substitution unit should use the same var name as another substitution unit. (For placeholders, this means the other placeholder is exactly the same as this one, i.e. it appears twice in the same message.)

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

clone

public MsgPluralRemainderNode clone()

Description copied from interface: Node

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

All clone() 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 clone() {
        return new T(this);
      }
   

• all non-leaf copy constructors should be protected

NOTE: this means we do not ultimately delegate to Object.clone(), ever.

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

Specified by:

clone in interface Node

Specified by:

clone in interface SoyNode

Specified by:

clone in class AbstractSoyNode

Returns:

A clone of this code.