BodyTag.java
上传用户:tanyanyong
上传日期:2013-06-23
资源大小:1355k
文件大小:5k
源码类别:

电子政务应用

开发平台:

MultiPlatform

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution, if
  20.  *    any, must include the following acknowlegement:  
  21.  *       "This product includes software developed by the 
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowlegement may appear in the software itself,
  24.  *    if and wherever such third-party acknowlegements normally appear.
  25.  *
  26.  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
  27.  *    Foundation" must not be used to endorse or promote products derived
  28.  *    from this software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache"
  32.  *    nor may "Apache" appear in their names without prior written
  33.  *    permission of the Apache Group.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  */
  55. package javax.servlet.jsp.tagext;
  56. import javax.servlet.jsp.*;
  57. /**
  58.  * The BodyTag interface extends Tag by defining additional methods that let
  59.  * a Tag handler access its body.
  60.  * <p>
  61.  * The interface provides two new methods: one is to be invoked with the BodyContent
  62.  * for the evaluation of the body, the other is to be reevaluated after every body
  63.  * evaluation.
  64.  * <p>
  65.  * Without repeating the portions described in Tag.java, a typical invocation sequence is:
  66.  *
  67.  * <pre>
  68.  * <code>
  69.  *
  70.  * -- we are picking up after all the setters have been done
  71.  * t.doStartTag();
  72.  * out = pageContext.pushBody();
  73.  * -- prepare for body
  74.  * t.setBodyContent(out);
  75.  * -- preamble
  76.  * t.doBodyInit();
  77.  * -- BODY evaluation into out
  78.  * t.doAfterBody();
  79.  * -- while doAfterBody returns EVAL_BODY_TAG we iterate
  80.  * -- BODY evaluation into out
  81.  * t.doAfterBody()
  82.  * -- done
  83.  * t.doEndTag()
  84.  *
  85.  * </code>
  86.  * </pre>
  87.  */
  88. public interface BodyTag extends Tag {
  89.     /**
  90.      * Request the creation of new BodyContent on which to evaluate the
  91.      * body of this tag.
  92.      * Returned from doStartTag and doAfterBody.
  93.      * This is an illegal return value for doStartTag when the class does not
  94.      * implement BodyTag, since BodyTag is needed to manipulate the new Writer.
  95.      */
  96.  
  97.     public final static int EVAL_BODY_TAG = 2;
  98.     /**
  99.      * Setter method for the bodyContent property.
  100.      * <p>
  101.      * This method will not be invoked if there is no body evaluation.
  102.      *
  103.      * @param b the BodyContent
  104.      * @seealso #doInitBody
  105.      * @seealso #doAfterBody
  106.      */
  107.     void setBodyContent(BodyContent b);
  108.     /**
  109.      * Prepare for evaluation of the body.
  110.      * <p>
  111.      * The method will be invoked once per action invocation by the page implementation
  112.      * after a new BodyContent has been obtained and set on the tag handler
  113.      * via the setBodyContent() method and before the evaluation
  114.      * of the tag's body into that BodyContent.
  115.      * <p>
  116.      * This method will not be invoked if there is no body evaluation.
  117.      *
  118.      * @seealso #doAfterBody
  119.      */
  120.     void doInitBody() throws JspException;
  121.     /**
  122.      * Actions after some body has been evaluated.
  123.      * <p>
  124.      * Not invoked in empty tags or in tags returning SKIP_BODY in doStartTag()
  125.      * This method is invoked after every body evaluation.
  126.      * The pair "BODY -- doAfterBody()" is invoked initially if doStartTag()
  127.      * returned EVAL_BODY_TAG, and it is repeated as long
  128.      * as the doAfterBody() evaluation returns EVAL_BODY_TAG
  129.      * <p>
  130.      * The method re-invocations may be lead to different actions because
  131.      * there might have been some changes to shared state, or because
  132.      * of external computation.
  133.      *
  134.      * @returns whether additional evaluations of the body are desired
  135.      * @seealso #doInitBody
  136.      */
  137.     int doAfterBody() throws JspException;
  138. }