Source for org.jfree.chart.encoders.ImageEncoder

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * -------------------
  28:  * ImageEncoder.java
  29:  * -------------------
  30:  * (C) Copyright 2004, by Richard Atkinson and Contributors.
  31:  *
  32:  * Original Author:  Richard Atkinson;
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: ImageEncoder.java,v 1.3.2.1 2005/10/25 20:41:46 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 01-Aug-2004 : Initial version (RA);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.encoders;
  44: 
  45: import java.io.OutputStream;
  46: import java.io.IOException;
  47: import java.awt.image.BufferedImage;
  48: 
  49: /**
  50:  * Interface for abstracting different types of image encoders.
  51:  *
  52:  * @author Richard Atkinson
  53:  */
  54: public interface ImageEncoder {
  55: 
  56:     /**
  57:      * Encodes an image in a particular format.
  58:      *
  59:      * @param bufferedImage  The image to be encoded.
  60:      * 
  61:      * @return The byte[] that is the encoded image.
  62:      * 
  63:      * @throws IOException
  64:      */
  65:     public byte[] encode(BufferedImage bufferedImage) throws IOException;
  66: 
  67: 
  68:     /**
  69:      * Encodes an image in a particular format and writes it to an OutputStream.
  70:      *
  71:      * @param bufferedImage  The image to be encoded.
  72:      * @param outputStream  The OutputStream to write the encoded image to.
  73:      * @throws IOException
  74:      */
  75:     public void encode(BufferedImage bufferedImage, OutputStream outputStream) 
  76:         throws IOException;
  77: 
  78:     /**
  79:      * Get the quality of the image encoding.
  80:      *
  81:      * @return A float representing the quality.
  82:      */
  83:     public float getQuality();
  84: 
  85:     /**
  86:      * Set the quality of the image encoding (not supported by all 
  87:      * ImageEncoders).
  88:      *
  89:      * @param quality  A float representing the quality.
  90:      */
  91:     public void setQuality(float quality);
  92: 
  93:     /**
  94:      * Get whether the encoder should encode alpha transparency.
  95:      *
  96:      * @return Whether the encoder is encoding alpha transparency.
  97:      */
  98:     public boolean isEncodingAlpha();
  99: 
 100:     /**
 101:      * Set whether the encoder should encode alpha transparency (not 
 102:      * supported by all ImageEncoders).
 103:      *
 104:      * @param encodingAlpha  Whether the encoder should encode alpha 
 105:      *                       transparency.
 106:      */
 107:     public void setEncodingAlpha(boolean encodingAlpha);
 108: 
 109: }