org.apache.velocity.runtime.directive: public class: Literal

org.apache.velocity.runtime.directive
public class: Literal [javadoc | source]

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

All Implemented Interfaces:
Cloneable, DirectiveConstants

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().

author: < - a href="mailto:jvanzyl@apache.org">Jason van Zyl

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

Field Summary
String	literalText

Fields inherited from org.apache.velocity.runtime.directive.Directive:
rsvc

Method from org.apache.velocity.runtime.directive.Literal Summary:
getName, getType, init, render

Methods from org.apache.velocity.runtime.directive.Directive:
getColumn, getLine, getName, getType, init, render, setLocation

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.velocity.runtime.directive.Literal Detail:
public String getName() { return "literal"; } Return name of this directive.
public int getType() { return BLOCK; } Return type of this directive.
public void init(RuntimeServices rs, InternalContextAdapter context, Node node) throws TemplateInitException { super.init( rs, context, node ); literalText = node.jjtGetChild(0).literal(); } Store the literal rendition of a node using the Node.literal().
public boolean render(InternalContextAdapter context, Writer writer, Node node) throws IOException { writer.write(literalText); return true; } Throw the literal rendition of the block between #literal()/#end into the writer.

Method from org.apache.velocity.runtime.directive.Literal Detail:

 public String getName() {
        return "literal";
}

Return name of this directive.

 public int getType() {
        return BLOCK;
}

Return type of this directive.

 public  void init(RuntimeServices rs,
    InternalContextAdapter context,
    Node node) throws TemplateInitException {
        super.init( rs, context, node );
        literalText = node.jjtGetChild(0).literal();
}

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

 public boolean render(InternalContextAdapter context,
    Writer writer,
    Node node) throws IOException {
        writer.write(literalText);
        return true;
}

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