cvs commit: jakarta-struts/src/share/org/apache/struts/taglib/template PutTag.java

[dg...@locus.apache.org]

dgeary      00/10/07 18:20:51

  Added:       src/share/org/apache/struts/taglib/template PutTag.java
  Log:
  Tag handler for template:put tag
  
  Revision  Changes    Path
  1.1                  jakarta-struts/src/share/org/apache/struts/taglib/template/PutTag.java
  
  Index: PutTag.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/template/PutTag.java,v 1.1 2000/10/08 01:20:50 dgeary Exp $
   * $Revision: 1.1 $
   * $Date: 2000/10/08 01:20:50 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 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/>.
   *
   */
  package org.apache.struts.taglib.template;
  
  import java.util.Hashtable;
  import java.util.Stack;
  import javax.servlet.jsp.JspException;
  import javax.servlet.jsp.tagext.TagSupport;
  
  import org.apache.struts.taglib.template.util.Content;
  
  /**
   * Tag handler for <template:put>, which puts content into request scope.
   *
   * @author David Geary
   * @version $Revision: 1.1 $ $Date: 2000/10/08 01:20:50 $
   */
  public class PutTag extends TagSupport {
  
  // ----------------------------------------------------- Instance Variables
  
  
     /**
       * The content's name.
       */
     private String name;
  
  
     /**
       * The content's URI (or text).
       */
     private String content;
  
  
     /**
       * Determines whether content is included (false) or printed (true).
       * Content is included (false) by default.
       */
     private String direct="false";
  
  // --------------------------------------------------------- Public Methods
  
  
     /**
       * Set the content name.
       */
     public void setName(String name) { 
  
        this.name = name; 
  
     }
  
  
     /**
       * Set the content's URI (if it's to be included) or text (if it's to
       * be printed).
       */
     public void setContent(String content) {
  
        this.content = content; 
  
     }
  
  
     /**
       * Set direct to true, and content will be printed directly, instead
       * of included (direct == false).
       */
     public void setDirect(String direct) { 
  
        this.direct = direct; 
  
     }
  
  
     /**
       * Process the end tag by putting content into the enclosing
       * insert tag.
       *
       * @exception JspException if this tag is not enclosed by 
       * <template:insert>.
       */
     public int doEndTag() throws JspException {
  
        InsertTag insertTag = (InsertTag)getAncestor(
                                "tags.templates.InsertTag");
        if(insertTag == null)
           throw new JspException("PutTag.doStartTag(): " +
                                  "No InsertTag ancestor");
  
        insertTag.put(name, new Content(content, direct));
        return EVAL_PAGE;
  
     }
  
  
     /**
       * Reset member variables. 
       */
     public void release() {
  
        name = content = direct = null;
  
     }
  
  
     /**
       * Convenience method for locating ancestor tags by class name. 
       *
       * @param className The name of the ancestor class.
       */
     private TagSupport getAncestor(String className) 
                                   throws JspException {
  
        Class klass = null; // can�t name variable "class"
        try {
           klass = Class.forName(className);
        }
        catch(ClassNotFoundException ex) {
           throw new JspException(ex.getMessage());
        }
        return (TagSupport)findAncestorWithClass(this, klass);
  
     }
  }