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

Class Include

java.lang.Object

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

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

net.sourceforge.pmd.lang.vm.directive.Include

All Implemented Interfaces:

java.lang.Cloneable

public class Include
extends InputBase

Pluggable directive that handles the #include() statement in VTL. This #include() can take multiple arguments of either StringLiteral or Reference.

Notes:

1. For security reasons, the included source material can only come from somewhere within the template root tree. If you want to include content from elsewhere on your disk, add extra template roots, or use a link from somwhere under template root to that content.
2. By default, there is no output to the render stream in the event of a problem. You can override this behavior with two property values : include.output.errormsg.start include.output.errormsg.end If both are defined in velocity.properties, they will be used to in the render output to bracket the arg string that caused the problem. Ex. : if you are working in html then include.output.errormsg.start=<!-- #include error : include.output.errormsg.end= --> might be an excellent way to start...
3. As noted above, #include() can take multiple arguments. Ex : #include('foo.vm' 'bar.vm' $foo) will include all three if valid to output without any special separator.

Version:

$Id: Include.java 746438 2009-02-21 05:41:24Z nbubna $

Author:

Geir Magnusson Jr., Jason van Zyl, Kasper Nielsen

Field Summary

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

BLOCK, LINE

Constructor Summary

Constructors

Constructor	Description
Include()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Return name of this directive.
int	getType()	Return type of this directive.
boolean	isScopeProvided()	Since there is no processing of content, there is never a need for an internal scope.

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

getColumn, getLine, getScopeName, getTemplateName, setLocation, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

Include

public Include()

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.

getType

public int getType()

Return type of this directive.

Specified by:

getType in class Directive

Returns:

The type of this directive.

isScopeProvided

public boolean isScopeProvided()

Since there is no processing of content, there is never a need for an internal scope.

Overrides:

isScopeProvided in class Directive

Returns:

true if there will be a scope control injected into the context when rendering this directive.