com.google.template.soy.sharedpasses

Class CheckSoyDocVisitor

java.lang.Object

com.google.template.soy.basetree.AbstractNodeVisitor<SoyNode,R>

com.google.template.soy.soytree.AbstractSoyNodeVisitor<Void>

com.google.template.soy.sharedpasses.CheckSoyDocVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,Void>

public final class CheckSoyDocVisitor
extends AbstractSoyNodeVisitor<Void>

Visitor for checking that in each template, the parameters declared in the SoyDoc match the data keys referenced in the template.

Important: Do not use outside of Soy code (treat as superpackage-private).

Precondition: All template and callee names should be full names (i.e. you must execute SetFullCalleeNamesVisitor before executing this visitor).

Note this visitor only works for code in Soy V2 syntax.

AbstractNodeVisitor.exec(N) should be called on a full parse tree. There is no return value. However, a SoySyntaxException is thrown if the parameters declared in some template's SoyDoc do not match the data keys referenced in that template.

Field Summary

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

errorReporter

Constructor Summary

Constructors

Constructor and Description
CheckSoyDocVisitor(SyntaxVersion declaredSyntaxVersion, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
protected void	visitCallNode(CallNode node)
protected void	visitSoyFileSetNode(SoyFileSetNode node)
protected void	visitSoyNode(SoyNode node)
protected void	visitTemplateNode(TemplateNode node)

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

visit, visitCallBasicNode, visitCallDelegateNode, visitCallParamContentNode, visitCallParamNode, visitCallParamValueNode, visitChildren, visitChildrenAllowingConcurrentModification, visitCssNode, visitDebuggerNode, visitForeachIfemptyNode, visitForeachNode, visitForeachNonemptyNode, visitForNode, visitGoogMsgDefNode, visitGoogMsgRefNode, visitIfCondNode, visitIfElseNode, visitIfNode, visitLetContentNode, visitLetNode, visitLetValueNode, visitLogNode, visitLoopNode, visitMsgFallbackGroupNode, visitMsgHtmlTagNode, visitMsgNode, visitMsgPlaceholderNode, visitMsgPluralCaseNode, visitMsgPluralDefaultNode, visitMsgPluralNode, visitMsgPluralRemainderNode, visitMsgSelectCaseNode, visitMsgSelectDefaultNode, visitMsgSelectNode, visitMsgSubstUnitNode, visitPrintDirectiveNode, visitPrintNode, visitRawTextNode, visitSoyFileNode, visitSwitchCaseNode, visitSwitchDefaultNode, visitSwitchNode, visitTemplateBasicNode, visitTemplateDelegateNode, visitXidNode

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

exec, visitChildren, visitChildrenAllowingConcurrentModification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CheckSoyDocVisitor

public CheckSoyDocVisitor(SyntaxVersion declaredSyntaxVersion,
                          ErrorReporter errorReporter)

Parameters:

declaredSyntaxVersion - User-declared syntax version,

Method Detail

visitSoyFileSetNode

protected void visitSoyFileSetNode(SoyFileSetNode node)

Overrides:

visitSoyFileSetNode in class AbstractSoyNodeVisitor<Void>

Throws:

SoySyntaxException - If the parameters declared in some template's SoyDoc do not match the data keys referenced in that template.

visitTemplateNode

protected void visitTemplateNode(TemplateNode node)

Overrides:

visitTemplateNode in class AbstractSoyNodeVisitor<Void>

Throws:

SoySyntaxException - If the parameters declared in some template's SoyDoc do not match the data keys referenced in that template.

visitCallNode

protected void visitCallNode(CallNode node)

Overrides:

visitCallNode in class AbstractSoyNodeVisitor<Void>

visitSoyNode

protected void visitSoyNode(SoyNode node)

Overrides:

visitSoyNode in class AbstractSoyNodeVisitor<Void>

Parameters:

node - the visited node.