Class NodeViewMode
- java.lang.Object
-
- org.apache.velocity.runtime.visitor.BaseVisitor
-
- org.apache.velocity.runtime.visitor.NodeViewMode
-
- All Implemented Interfaces:
ParserVisitor
public class NodeViewMode extends BaseVisitor
This class is simply a visitor implementation that traverses the AST, produced by the Velocity parsing process, and creates a visual structure of the AST. This is primarily used for debugging, but it useful for documentation as well.- Version:
- $Id: NodeViewMode.java 747106 2009-02-23 19:25:14Z nbubna $
-
-
Field Summary
Fields Modifier and Type Field Description private int
indent
private boolean
showTokens
-
Fields inherited from class org.apache.velocity.runtime.visitor.BaseVisitor
context, writer
-
-
Constructor Summary
Constructors Constructor Description NodeViewMode()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private java.lang.String
indentString()
Indent child nodes to help visually identify the structure of the AST.private java.lang.Object
showNode(Node node, java.lang.Object data)
Display the type of nodes and optionally the first token.java.lang.Object
visit(ASTAddNode node, java.lang.Object data)
java.lang.Object
visit(ASTAndNode node, java.lang.Object data)
java.lang.Object
visit(ASTAssignment node, java.lang.Object data)
java.lang.Object
visit(ASTBlock node, java.lang.Object data)
java.lang.Object
visit(ASTDirective node, java.lang.Object data)
java.lang.Object
visit(ASTDivNode node, java.lang.Object data)
java.lang.Object
visit(ASTElseIfStatement node, java.lang.Object data)
java.lang.Object
visit(ASTElseStatement node, java.lang.Object data)
java.lang.Object
visit(ASTEQNode node, java.lang.Object data)
java.lang.Object
visit(ASTEscapedDirective node, java.lang.Object data)
java.lang.Object
visit(ASTEscape node, java.lang.Object data)
java.lang.Object
visit(ASTExpression node, java.lang.Object data)
java.lang.Object
visit(ASTFalse node, java.lang.Object data)
java.lang.Object
visit(ASTFloatingPointLiteral node, java.lang.Object data)
java.lang.Object
visit(ASTGENode node, java.lang.Object data)
java.lang.Object
visit(ASTGTNode node, java.lang.Object data)
java.lang.Object
visit(ASTIdentifier node, java.lang.Object data)
java.lang.Object
visit(ASTIfStatement node, java.lang.Object data)
java.lang.Object
visit(ASTIntegerLiteral node, java.lang.Object data)
java.lang.Object
visit(ASTIntegerRange node, java.lang.Object data)
java.lang.Object
visit(ASTLENode node, java.lang.Object data)
java.lang.Object
visit(ASTLTNode node, java.lang.Object data)
java.lang.Object
visit(ASTMap node, java.lang.Object data)
java.lang.Object
visit(ASTMethod node, java.lang.Object data)
java.lang.Object
visit(ASTModNode node, java.lang.Object data)
java.lang.Object
visit(ASTMulNode node, java.lang.Object data)
java.lang.Object
visit(ASTNENode node, java.lang.Object data)
java.lang.Object
visit(ASTNotNode node, java.lang.Object data)
java.lang.Object
visit(ASTObjectArray node, java.lang.Object data)
java.lang.Object
visit(ASTOrNode node, java.lang.Object data)
java.lang.Object
visit(ASTprocess node, java.lang.Object data)
java.lang.Object
visit(ASTReference node, java.lang.Object data)
java.lang.Object
visit(ASTSetDirective node, java.lang.Object data)
java.lang.Object
visit(ASTStringLiteral node, java.lang.Object data)
java.lang.Object
visit(ASTSubtractNode node, java.lang.Object data)
java.lang.Object
visit(ASTText node, java.lang.Object data)
java.lang.Object
visit(ASTTrue node, java.lang.Object data)
java.lang.Object
visit(ASTWord node, java.lang.Object data)
java.lang.Object
visit(SimpleNode node, java.lang.Object data)
-
Methods inherited from class org.apache.velocity.runtime.visitor.BaseVisitor
setContext, setWriter, visit
-
-
-
-
Method Detail
-
indentString
private java.lang.String indentString()
Indent child nodes to help visually identify the structure of the AST.
-
showNode
private java.lang.Object showNode(Node node, java.lang.Object data)
Display the type of nodes and optionally the first token.
-
visit
public java.lang.Object visit(SimpleNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.SimpleNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTprocess node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTprocess, java.lang.Object)
-
visit
public java.lang.Object visit(ASTExpression node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTExpression, java.lang.Object)
-
visit
public java.lang.Object visit(ASTAssignment node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTAssignment, java.lang.Object)
-
visit
public java.lang.Object visit(ASTOrNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTOrNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTAndNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTAndNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTEQNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTEQNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTNENode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTNENode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTLTNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTLTNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTGTNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTGTNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTLENode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTLENode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTGENode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTGENode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTAddNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTAddNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTSubtractNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTSubtractNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTMulNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTMulNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTDivNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTDivNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTModNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTModNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTNotNode node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTNotNode, java.lang.Object)
-
visit
public java.lang.Object visit(ASTFloatingPointLiteral node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTFloatingPointLiteral, java.lang.Object)
-
visit
public java.lang.Object visit(ASTIntegerLiteral node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- Since:
- 1.5
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTIntegerLiteral, java.lang.Object)
-
visit
public java.lang.Object visit(ASTStringLiteral node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTStringLiteral, java.lang.Object)
-
visit
public java.lang.Object visit(ASTIdentifier node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTIdentifier, java.lang.Object)
-
visit
public java.lang.Object visit(ASTMethod node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTMethod, java.lang.Object)
-
visit
public java.lang.Object visit(ASTReference node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTReference, java.lang.Object)
-
visit
public java.lang.Object visit(ASTTrue node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTTrue, java.lang.Object)
-
visit
public java.lang.Object visit(ASTFalse node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTFalse, java.lang.Object)
-
visit
public java.lang.Object visit(ASTBlock node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTBlock, java.lang.Object)
-
visit
public java.lang.Object visit(ASTText node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTText, java.lang.Object)
-
visit
public java.lang.Object visit(ASTIfStatement node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTIfStatement, java.lang.Object)
-
visit
public java.lang.Object visit(ASTElseStatement node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTElseStatement, java.lang.Object)
-
visit
public java.lang.Object visit(ASTElseIfStatement node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTElseIfStatement, java.lang.Object)
-
visit
public java.lang.Object visit(ASTObjectArray node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTObjectArray, java.lang.Object)
-
visit
public java.lang.Object visit(ASTDirective node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTDirective, java.lang.Object)
-
visit
public java.lang.Object visit(ASTWord node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTWord, java.lang.Object)
-
visit
public java.lang.Object visit(ASTSetDirective node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTSetDirective, java.lang.Object)
-
visit
public java.lang.Object visit(ASTEscapedDirective node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- Since:
- 1.5
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTEscapedDirective, java.lang.Object)
-
visit
public java.lang.Object visit(ASTEscape node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- Since:
- 1.5
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTEscape, java.lang.Object)
-
visit
public java.lang.Object visit(ASTMap node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- Since:
- 1.5
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTMap, java.lang.Object)
-
visit
public java.lang.Object visit(ASTIntegerRange node, java.lang.Object data)
- Specified by:
visit
in interfaceParserVisitor
- Overrides:
visit
in classBaseVisitor
- Returns:
- The object rendered by this node.
- See Also:
BaseVisitor.visit(org.apache.velocity.runtime.parser.node.ASTIntegerRange, java.lang.Object)
-
-