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:

java.lang.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,v 1.6 2001/10/22 03:53:24 jon Exp $

Author:

Jason van Zyl

Field Summary

(package private) java.lang.String

literalText

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

column, line, rsvc

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

BLOCK, LINE

Constructor Summary

Literal()

Method Summary

java.lang.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, java.io.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, registerNatives, toString, wait, wait, wait

Field Detail

literalText

java.lang.String literalText

Constructor Detail

Literal

public Literal()

Method Detail

getName

public java.lang.String getName()

Return name of this directive.

Overrides:

getName in class Directive

getType

public int getType()

Return type of this directive.

Overrides:

getType in class Directive

init

public void init(RuntimeServices rs,
                 InternalContextAdapter context,
                 Node node)
          throws java.lang.Exception

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

Overrides:

init in class Directive

render

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

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

Overrides:

render in class Directive