Package net.sourceforge.pmd.lang.vm.directive

Class Parse

java.lang.Object

net.sourceforge.pmd.lang.vm.directive.Directive

net.sourceforge.pmd.lang.vm.directive.InputBase

net.sourceforge.pmd.lang.vm.directive.Parse

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
    "directive.parse.max.depth = 10" by default.  This 10 deep
    limit is a safety feature to prevent infinite loops.
 

Version:

$Id: Parse.java 928253 2010-03-27 19:39:04Z nbubna $

Author:

Geir Magnusson Jr., Jason van Zyl, Christoph Reck

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.vm.directive.Directive

BLOCK, LINE

Constructor Summary

Constructors

Constructor	Description
Parse()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Return name of this directive.
java.lang.String	getScopeName()	Overrides the default to use "template", so that all templates can use the same scope reference, whether rendered via #parse or direct merge.
int	getType()	Return type of this directive.

Methods inherited from class net.sourceforge.pmd.lang.vm.directive.Directive

getColumn, getLine, getTemplateName, isScopeProvided, setLocation, 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 java.lang.String getName()

Return name of this directive.

Specified by:

getName in class InputBase

Returns:

The name of this directive.

getScopeName

public java.lang.String getScopeName()

Overrides the default to use "template", so that all templates can use the same scope reference, whether rendered via #parse or direct merge.

Overrides:

getScopeName in class Directive

Returns:

the name to be used when a scope control is provided for this directive.

getType

public int getType()

Return type of this directive.

Specified by:

getType in class Directive

Returns:

The type of this directive.