org.apache.velocity.runtime.directive
Class Parse

java.lang.Object
  org.apache.velocity.runtime.directive.Directive
      org.apache.velocity.runtime.directive.InputBase
          org.apache.velocity.runtime.directive.Parse

All Implemented Interfaces:

Cloneable, DirectiveConstants

public class Parse
extends InputBase

Pluggable directive that handles the #parse() statement in VTL.

 Notes:
 -----
  1) The parsed source material can only come from somewhere in
    the TemplateRoot tree for security reasons. There is no way
    around this.  If you want to include content from elsewhere on
    your disk, use a link from somwhere under Template Root to that
    content.

  2) There is a limited parse depth.  It is set as a property
    "parse_directive.maxdepth = 10"  for example.  There is a 20 iteration
    safety in the event that the parameter isn't set.
 

Version:

$Id: Parse.java 463298 2006-10-12 16:10:32Z henning $

Author:

Geir Magnusson Jr., Jason van Zyl, Christoph Reck

Field Summary

Fields inherited from class org.apache.velocity.runtime.directive.Directive

rsvc

Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants

BLOCK, LINE

Constructor Summary

Parse()

Method Summary

String	getName() Return name of this directive.
int	getType() Return type of this directive.
boolean	render(InternalContextAdapter context, Writer writer, Node node) iterates through the argument list and renders every argument that is appropriate.

Methods inherited from class org.apache.velocity.runtime.directive.InputBase

getInputEncoding

Methods inherited from class org.apache.velocity.runtime.directive.Directive

getColumn, getLine, init, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

Parse

public Parse()

Method Detail

getName

public String getName()

Return name of this directive.

Specified by:

getName in class Directive

Returns:

The name of this directive.

getType

public int getType()

Return type of this directive.

Specified by:

getType in class Directive

Returns:

The type of this directive.

render

public boolean render(InternalContextAdapter context,
                      Writer writer,
                      Node node)
               throws IOException,
                      ResourceNotFoundException,
                      ParseErrorException,
                      MethodInvocationException

iterates through the argument list and renders every argument that is appropriate. Any non appropriate arguments are logged, but render() continues.

Specified by:

render in class Directive

Parameters:

context -

writer -

node -

Returns:

True if the directive rendered successfully.

Throws:

IOException

ResourceNotFoundException

ParseErrorException

MethodInvocationException