1   /*
    2   * Licensed to the Apache Software Foundation (ASF) under one or more
    3   * contributor license agreements.  See the NOTICE file distributed with
    4   * this work for additional information regarding copyright ownership.
    5   * The ASF licenses this file to You under the Apache License, Version 2.0
    6   * (the "License"); you may not use this file except in compliance with
    7   * the License.  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   package javax.servlet.jsp.tagext;
   20   
   21   import java.io.InputStream;
   22   
   23   /**
   24    * Translation-time information on a JSP page.  The information
   25    * corresponds to the XML view of the JSP page.
   26    *
   27    * <p>
   28    * Objects of this type are generated by the JSP translator, e.g.
   29    * when being pased to a TagLibraryValidator instance.
   30    */
   31   
   32   abstract public class PageData {
   33   
   34       /**
   35        * Sole constructor. (For invocation by subclass constructors, 
   36        * typically implicit.)
   37        */
   38       public PageData() {
   39       }
   40       
   41       /**
   42        * Returns an input stream on the XML view of a JSP page.
   43        * The stream is encoded in UTF-8.  Recall tht the XML view of a 
   44        * JSP page has the include directives expanded.
   45        * 
   46        * @return An input stream on the document.
   47        */
   48      abstract public InputStream getInputStream();
   49   }