org.apache.velocity.runtime.directive

Class Literal

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,v 1.7.4.1 2004/03/03 23:22:56 geirm Exp $
Author:
Jason van Zyl

Field Summary

(package private) 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

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, getName, getType, init, render, setLocation

Field Details

literalText

(package private)  String literalText

Method Details

getName

public String getName()
Return name of this directive.
Overrides:
getName in interface Directive

getType

public int getType()
Return type of this directive.
Overrides:
getType in interface Directive

init

public void init(RuntimeServices rs,
                 InternalContextAdapter context,
                 Node node)
            throws Exception
Store the literal rendition of a node using the Node.literal().
Overrides:
init in interface Directive

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.
Overrides:
render in interface Directive

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.