com.google.template.soy.soytree

Class SoyFileNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractParentSoyNode<TemplateNode>

com.google.template.soy.soytree.SoyFileNode

All Implemented Interfaces:

Node, ParentNode<TemplateNode>, SoyNode, SoyNode.ParentSoyNode<TemplateNode>, SoyNode.SplitLevelTopNode<TemplateNode>

public final class SoyFileNode
extends AbstractParentSoyNode<TemplateNode>
implements SoyNode.SplitLevelTopNode<TemplateNode>

Node representing a Soy file.

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

Modifier and Type	Field and Description
static com.google.common.base.Predicate<SoyFileNode>	MATCH_SRC_FILENODE

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

SPACES

Constructor Summary

Constructors

Constructor and Description
SoyFileNode(int id, String filePath, SoyFileKind soyFileKind, String delpackageCmdText, String namespaceCmdText, List<String> aliasCmdTexts)

Method Summary

Modifier and Type	Method and Description
SoyFileNode	clone() Copies this node.
com.google.common.collect.ImmutableMap<String,String>	getAliasToNamespaceMap() Returns the map from aliases to namespaces for this file.
String	getCssBaseNamespace() Returns the CSS base namespace for this file (usable in any template in this file).
AutoescapeMode	getDefaultAutoescapeMode() Returns the default autoescaping mode for contained templates.
String	getDelPackageName() Returns the name of the containing delegate package, or null if none.
String	getFileName() Returns this Soy file's name (null if not supplied).
String	getFilePath() Returns the path to the source Soy file ("unknown" if not supplied).
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	getNamespace() Returns this Soy file's namespace, or null if syntax version V1.
SoyFileSetNode	getParent() Gets this node's parent.
com.google.common.collect.ImmutableList<String>	getRequiredCssNamespaces() Returns the CSS namespaces required by this file (usable in any template in this file).
SoyFileKind	getSoyFileKind() Returns the kind of this Soy file.
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, appendTreeStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild, toTreeString

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

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

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

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent, toTreeString

Field Detail

MATCH_SRC_FILENODE

public static final com.google.common.base.Predicate<SoyFileNode> MATCH_SRC_FILENODE

Constructor Detail

SoyFileNode

public SoyFileNode(int id,
                   String filePath,
                   SoyFileKind soyFileKind,
                   @Nullable
                   String delpackageCmdText,
                   @Nullable
                   String namespaceCmdText,
                   @Nullable
                   List<String> aliasCmdTexts)
            throws SoySyntaxException

Parameters:

id - The id for this node.

filePath - The path to the Soy source file.

soyFileKind - The kind of this Soy file.

delpackageCmdText - This Soy file's delegate package, or null if none.

namespaceCmdText - This Soy file's namespace and attributes. Nullable for backwards compatibility only.

aliasCmdTexts - The command texts of the 'alias' declarations. Allowed to be null.

Throws:

SoySyntaxException - If a syntax error is found.

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

getSoyFileKind

public SoyFileKind getSoyFileKind()

Returns the kind of this Soy file.

getDelPackageName

@Nullable
public String getDelPackageName()

Returns the name of the containing delegate package, or null if none.

getNamespace

@Nullable
public String getNamespace()

Returns this Soy file's namespace, or null if syntax version V1.

getDefaultAutoescapeMode

public AutoescapeMode getDefaultAutoescapeMode()

Returns the default autoescaping mode for contained templates.

getRequiredCssNamespaces

public com.google.common.collect.ImmutableList<String> getRequiredCssNamespaces()

Returns the CSS namespaces required by this file (usable in any template in this file).

getCssBaseNamespace

public String getCssBaseNamespace()

Returns the CSS base namespace for this file (usable in any template in this file).

getAliasToNamespaceMap

public com.google.common.collect.ImmutableMap<String,String> getAliasToNamespaceMap()

Returns the map from aliases to namespaces for this file.

getFilePath

public String getFilePath()

Returns the path to the source Soy file ("unknown" if not supplied).

getFileName

@Nullable
public String getFileName()

Returns this Soy file's name (null if not supplied).

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

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

clone

public SoyFileNode 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.