cvs commit: jakarta-velocity/src/java/org/apache/velocity/runtime/directive Literal.java

[jv...@locus.apache.org]

jvanzyl     00/12/19 00:23:39

  Added:       src/java/org/apache/velocity/runtime/directive Literal.java
  Log:
  - New #literal() directive to allow CDATA type behaviour, very handy
    in the case where you want to use velocity to generate velocity
    templates without having to escape everything.
  
  Revision  Changes    Path
  1.1                  jakarta-velocity/src/java/org/apache/velocity/runtime/directive/Literal.java
  
  Index: Literal.java
  ===================================================================
  package org.apache.velocity.runtime.directive;
  
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2000 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import java.io.*;
  
  import org.apache.velocity.Context;
  import org.apache.velocity.runtime.Runtime;
  import org.apache.velocity.runtime.parser.node.Node;
  
  /**
   * 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@periapt.com">Jason van Zyl</a>
   * @version $Id: Literal.java,v 1.1 2000/12/19 08:23:39 jvanzyl Exp $
   */
  public class Literal extends Directive
  {
      String literalText;
      
      /**
       * Return name of this directive.
       */
      public String getName()
      {
          return "literal";
      }        
      
      /**
       * Return type of this directive.
       */
      public int getType()
      {
          return BLOCK;
      }        
  
      /**
       * Store the literal rendition of a node using
       * the Node.literal().
       */
      public void init(Context context, Node node) throws Exception
      {
          literalText = node.jjtGetChild(0).literal();
      }    
  
      /**
       * Throw the literal rendition of the block between
       * #literal()/#end into the writer.
       */
      public boolean render(Context context, Writer writer, Node node)
          throws IOException
      {
          writer.write(literalText);
          return true;
      }
  }