ASTDirective (Velocity 1.4 API)
Keywords: org.apache.velocity.runtime.parser.node.ASTDirective class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.velocity.runtime.parser.node
Class ASTDirective

    java.lang.Object
      org.apache.velocity.runtime.parser.node.SimpleNode
          org.apache.velocity.runtime.parser.node.ASTDirective

All Implemented Interfaces:
  Node

public class ASTDirective
extends SimpleNode

This class is responsible for handling the pluggable directives in VTL. ex. #foreach() Please look at the Parser.jjt file which is what controls the generation of this class.

Version:
  $Id: ASTDirective.java,v 1.21.4.1 2004/03/03 23:22:58 geirm Exp $
Author:
  Jason van Zyl, Geir Magnusson Jr., Kasper Nielsen

Field Summary
`private Directive` | `directive`
`private java.lang.String` | `directiveName`
`private boolean` | `isDirective`

Fields inherited from class org.apache.velocity.runtime.parser.node.SimpleNode
`children, first, id, info, invalid, last, parent, parser, rsvc, state`

Constructor Summary
`ASTDirective(int id)`
`ASTDirective(Parser p, int id)`

Method Summary
`java.lang.String` | `getDirectiveName()` Gets the name of this directive.
`java.lang.Object` | `init(InternalContextAdapter context, java.lang.Object data)`
`java.lang.Object` | `jjtAccept(ParserVisitor visitor, java.lang.Object data)` Accept the visitor.
`boolean` | `render(InternalContextAdapter context, java.io.Writer writer)`
`void` | `setDirectiveName(java.lang.String str)` Sets the directive name.

Methods inherited from class org.apache.velocity.runtime.parser.node.SimpleNode
`childrenAccept, dump, evaluate, execute, getColumn, getFirstToken, getInfo, getLastToken, getLine, getType, isInvalid, jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, literal, setFirstToken, setInfo, setInvalid, toString, value`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### directive

    private Directive directive

### directiveName

    private java.lang.String directiveName

### isDirective

    private boolean isDirective

Constructor Detail

### ASTDirective

    public ASTDirective(int id)

### ASTDirective

    public ASTDirective(Parser p,
                        int id)

Method Detail

### jjtAccept

    public java.lang.Object jjtAccept(ParserVisitor visitor,
                                      java.lang.Object data)

  Accept the visitor.

  Specified by:
    `jjtAccept` in interface `Node`
  Overrides:
    `jjtAccept` in class `SimpleNode`

### init

    public java.lang.Object init(InternalContextAdapter context,
                                 java.lang.Object data)
                          throws java.lang.Exception

  Specified by:
    `init` in interface `Node`
  Overrides:
    `init` in class `SimpleNode`
  Throws:
    `java.lang.Exception`

### render

    public boolean render(InternalContextAdapter context,
                          java.io.Writer writer)
                   throws java.io.IOException,
                          MethodInvocationException,
                          ResourceNotFoundException,
                          ParseErrorException

  Specified by:
    `render` in interface `Node`
  Overrides:
    `render` in class `SimpleNode`
  Throws:
    `java.io.IOException`
    `MethodInvocationException`
    `ResourceNotFoundException`
    `ParseErrorException`

### setDirectiveName

    public void setDirectiveName(java.lang.String str)

  Sets the directive name. Used by the parser. This keeps us from having to dig it out of the token stream and gives the parse the change to override.

### getDirectiveName

    public java.lang.String getDirectiveName()

  Gets the name of this directive.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 Apache Software Foundation. All Rights Reserved.