View Javadoc

    1   /**
    2    *
    3    * Copyright 2003-2004 The Apache Software Foundation
    4    *
    5    *  Licensed under the Apache License, Version 2.0 (the "License");
    6    *  you may not use this file except in compliance with the License.
    7    *  You may obtain a copy of the License at
    8    *
    9    *     http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   *  Unless required by applicable law or agreed to in writing, software
    12   *  distributed under the License is distributed on an "AS IS" BASIS,
    13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   *  See the License for the specific language governing permissions and
    15   *  limitations under the License.
    16   */
    17
    18  //
    19  // This source code implements specifications defined by the Java
    20  // Community Process. In order to remain compliant with the specification
    21  // DO NOT add / change / or delete method signatures!
    22  //
    23
    24  package javax.servlet.jsp.tagext;
    25
    26  import java.io.InputStream;
    27
    28  /**
    29   * Translation-time information on a JSP page.  The information
    30   * corresponds to the XML view of the JSP page.
    31   *
    32   * <p>
    33   * Objects of this type are generated by the JSP translator, e.g.
    34   * when being pased to a TagLibraryValidator instance.
    35   */
    36
    37  abstract public class PageData {
    38
    39      /**
    40       * Sole constructor. (For invocation by subclass constructors,
    41       * typically implicit.)
    42       */
    43      public PageData() {
    44      }
    45
    46      /**
    47       * Returns an input stream on the XML view of a JSP page.
    48       * The stream is encoded in UTF-8.  Recall tht the XML view of a
    49       * JSP page has the include directives expanded.
    50       *
    51       * @return An input stream on the document.
    52       */
    53     abstract public InputStream getInputStream();
    54  }