cvs commit: xml-fop/src/org/apache/fop/image/analyser ImageReader.java

[es...@locus.apache.org]

eschaeffer    00/08/11 07:21:40

  Added:       src/org/apache/fop/image/analyser ImageReader.java
  Log:
  
  
  Revision  Changes    Path
  1.1                  xml-fop/src/org/apache/fop/image/analyser/ImageReader.java
  
  Index: ImageReader.java
  ===================================================================
  /*
   ============================================================================
                     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 modifica-
   tion, 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  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
   4. The names "Fop" 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 name,  without prior written permission  of the
      Apache Software Foundation.
   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 (INCLU-
   DING, 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 and was  originally created by
   James Tauber <jt...@jtauber.com>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
   */
  
  package org.apache.fop.image.analyser;
  
  // Java
  import java.io.BufferedInputStream;
  import java.io.IOException;
  
  /**
   * ImageReader objects read image headers to determine the image size.
   * @author Pankaj Narula
   * @version 1.0
   */
  public interface ImageReader {
    /**
      * Verify image type.
      * @param bis Image buffered input stream
      * @return true if image type is the handled one
      * @exception IOException io error
      */
    public boolean verifySignature(BufferedInputStream bis)
    throws IOException;
  
    /**
     * Return the used InputStream.
     * @return BufferedInputStream used to verify image type
     */
    public BufferedInputStream getInputStream();
  
    /**
     * Return correspondig mime type.
     * @return image mime type
     */
    public String getMimeType();
  
    /**
     * Return the image height.
     * @return image height
     */
    public int getHeight();
  
    /**
     * Return the image width.
     * @return image width
     */
    public int getWidth();
  }