org.apache.velocity.runtime.directive
Class Literal

java.lang.Object
  org.apache.velocity.runtime.directive.Directive
      org.apache.velocity.runtime.directive.Literal

All Implemented Interfaces:

Cloneable, DirectiveConstants

public class Literal
extends Directive

A very simple directive that leverages the Node.literal() to grab the literal rendition of a node. We basically grab the literal value on init(), then repeatedly use that during render().

Version:

$Id: Literal.java 471381 2006-11-05 08:56:58Z wglass $

Author:

Jason van Zyl

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

Literal()

Method Summary

String	getName() Return name of this directive.
int	getType() Return type of this directive.
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) Store the literal rendition of a node using the Node.literal().
boolean	render(InternalContextAdapter context, Writer writer, Node node) Throw the literal rendition of the block between #literal()/#end into the writer.

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, toString, wait, wait, wait

Constructor Detail

Literal

public Literal()

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.

init

public void init(RuntimeServices rs,
                 InternalContextAdapter context,
                 Node node)
          throws TemplateInitException

Store the literal rendition of a node using the Node.literal().

Overrides:

init in class Directive

Parameters:

rs -

context -

node -

Throws:

TemplateInitException

render

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

Throw the literal rendition of the block between #literal()/#end into the writer.

Specified by:

render in class Directive

Parameters:

context -

writer -

node -

Returns:

True if the directive rendered successfully.

Throws:

IOException