org.apache.velocity.runtime.directive
Class Macro

java.lang.Object
  |
  +--org.apache.velocity.runtime.directive.Directive
        |
        +--org.apache.velocity.runtime.directive.Macro
All Implemented Interfaces:
java.lang.Cloneable, DirectiveConstants

public class Macro
extends Directive

Macro.java Macro implements the macro definition directive of VTL. example : #macro( isnull $i ) #if( $i ) $i #end #end This object is used at parse time to mainly process and register the macro. It is used inline in the parser when processing a directive.

Version:
$Id: Macro.java,v 1.12 2001/03/20 01:11:24 jon Exp $
Author:
Geir Magnusson Jr.

Field Summary
private static boolean debugMode
           
 
Fields inherited from class org.apache.velocity.runtime.directive.Directive
column, line
 
Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants
BLOCK, LINE
 
Constructor Summary
Macro()
           
 
Method Summary
private  java.lang.String[] getArgArray(Node node)
          creates an array containing the literal strings in the macro arguement
private  java.lang.String[] getASTAsStringArray(Node rootNode)
          Returns an array of the literal rep of the AST
 java.lang.String getName()
          Return name of this directive.
 int getType()
          Return type of this directive.
 void init(InternalContextAdapter context, Node node)
          How this directive is to be initialized.
 void processAndRegister(Node node, java.lang.String sourceTemplate)
          Used by Parser.java to process VMs withing the parsing process processAndRegister() doesn't actually render the macro to the output Processes the macro body into the internal representation used by the VelocimacroProxy objects, and if not currently used, adds it to the macro Factory
 boolean render(InternalContextAdapter context, java.io.Writer writer, Node node)
          render() doesn't do anything in the final output rendering.
 
Methods inherited from class org.apache.velocity.runtime.directive.Directive
getColumn, getLine, setLocation
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

debugMode

private static boolean debugMode
Constructor Detail

Macro

public Macro()
Method Detail

getName

public java.lang.String getName()
Return name of this directive.
Overrides:
getName in class Directive

getType

public int getType()
Return type of this directive.
Overrides:
getType in class Directive

render

public boolean render(InternalContextAdapter context,
                      java.io.Writer writer,
                      Node node)
               throws java.io.IOException
render() doesn't do anything in the final output rendering. There is no output from a #macro() directive.
Overrides:
render in class Directive

init

public void init(InternalContextAdapter context,
                 Node node)
          throws java.lang.Exception
Description copied from class: Directive
How this directive is to be initialized.
Overrides:
init in class Directive

processAndRegister

public void processAndRegister(Node node,
                               java.lang.String sourceTemplate)
                        throws java.io.IOException
Used by Parser.java to process VMs withing the parsing process processAndRegister() doesn't actually render the macro to the output Processes the macro body into the internal representation used by the VelocimacroProxy objects, and if not currently used, adds it to the macro Factory

getArgArray

private java.lang.String[] getArgArray(Node node)
creates an array containing the literal strings in the macro arguement

getASTAsStringArray

private java.lang.String[] getASTAsStringArray(Node rootNode)
Returns an array of the literal rep of the AST


Copyright © 2001 Apache Software Foundation. All Rights Reserved.