001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -----------------
028 * ImageEncoder.java
029 * -----------------
030 * (C) Copyright 2004-present, by Richard Atkinson and Contributors.
031 *
032 * Original Author:  Richard Atkinson;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.encoders;
038
039import java.awt.image.BufferedImage;
040import java.io.IOException;
041import java.io.OutputStream;
042
043/**
044 * Interface for abstracting different types of image encoders.
045 */
046public interface ImageEncoder {
047
048    /**
049     * Encodes an image in a particular format.
050     *
051     * @param bufferedImage  The image to be encoded.
052     *
053     * @return The byte[] that is the encoded image.
054     *
055     * @throws IOException if there is an IO problem.
056     */
057    byte[] encode(BufferedImage bufferedImage) throws IOException;
058
059    /**
060     * Encodes an image in a particular format and writes it to an OutputStream.
061     *
062     * @param bufferedImage  The image to be encoded.
063     * @param outputStream  The OutputStream to write the encoded image to.
064     * @throws IOException if there is an IO problem.
065     */
066    void encode(BufferedImage bufferedImage, OutputStream outputStream)
067        throws IOException;
068
069    /**
070     * Get the quality of the image encoding.
071     *
072     * @return A float representing the quality.
073     */
074    float getQuality();
075
076    /**
077     * Set the quality of the image encoding (not supported by all
078     * ImageEncoders).
079     *
080     * @param quality  A float representing the quality.
081     */
082    void setQuality(float quality);
083
084    /**
085     * Get whether the encoder should encode alpha transparency.
086     *
087     * @return Whether the encoder is encoding alpha transparency.
088     */
089    boolean isEncodingAlpha();
090
091    /**
092     * Set whether the encoder should encode alpha transparency (not
093     * supported by all ImageEncoders).
094     *
095     * @param encodingAlpha  Whether the encoder should encode alpha
096     *                       transparency.
097     */
098    void setEncodingAlpha(boolean encodingAlpha);
099
100}