org.apache.velocity.runtime.directive
Class Include
- Cloneable, DirectiveConstants
Pluggable directive that handles the #include() statement in VTL.
This #include() can take multiple arguments of either
StringLiteral or Reference.
Notes:
-----
1) The included 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) 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 simply include all three if valid to output w/o any
special separator.
Version:
- Geir Magnusson Jr.
- Jason van Zyl
- Kasper Nielsen
outputMsgEnd
private String outputMsgEnd
outputMsgStart
private String outputMsgStart
getName
public String getName()
Return name of this directive.
- getName in interface Directive
getType
public int getType()
Return type of this directive.
- getType in interface Directive
outputErrorToStream
private void outputErrorToStream(Writer writer,
String msg)
throws IOException
Puts a message to the render output stream if ERRORMSG_START / END
are valid property strings. Mainly used for end-user template
debugging.
renderOutput
private boolean renderOutput(Node node,
InternalContextAdapter context,
Writer writer)
throws IOException,
MethodInvocationException,
ResourceNotFoundException
does the actual rendering of the included file
node
- AST argument of type StringLiteral or Referencecontext
- valid context so we can render Referenceswriter
- output Writer
- boolean success or failure. failures are logged
Copyright B) 2002 Apache Software Foundation. All Rights Reserved.