Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2007, 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-2007, by Richard Atkinson and Contributors. 31: * 32: * Original Author: Richard Atkinson; 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 01-Aug-2004 : Initial version (RA); 38: * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG); 39: * 40: */ 41: 42: package org.jfree.chart.encoders; 43: 44: import java.awt.image.BufferedImage; 45: import java.io.IOException; 46: import java.io.OutputStream; 47: 48: /** 49: * Interface for abstracting different types of image encoders. 50: */ 51: public interface ImageEncoder { 52: 53: /** 54: * Encodes an image in a particular format. 55: * 56: * @param bufferedImage The image to be encoded. 57: * 58: * @return The byte[] that is the encoded image. 59: * 60: * @throws IOException 61: */ 62: public byte[] encode(BufferedImage bufferedImage) throws IOException; 63: 64: 65: /** 66: * Encodes an image in a particular format and writes it to an OutputStream. 67: * 68: * @param bufferedImage The image to be encoded. 69: * @param outputStream The OutputStream to write the encoded image to. 70: * @throws IOException 71: */ 72: public void encode(BufferedImage bufferedImage, OutputStream outputStream) 73: throws IOException; 74: 75: /** 76: * Get the quality of the image encoding. 77: * 78: * @return A float representing the quality. 79: */ 80: public float getQuality(); 81: 82: /** 83: * Set the quality of the image encoding (not supported by all 84: * ImageEncoders). 85: * 86: * @param quality A float representing the quality. 87: */ 88: public void setQuality(float quality); 89: 90: /** 91: * Get whether the encoder should encode alpha transparency. 92: * 93: * @return Whether the encoder is encoding alpha transparency. 94: */ 95: public boolean isEncodingAlpha(); 96: 97: /** 98: * Set whether the encoder should encode alpha transparency (not 99: * supported by all ImageEncoders). 100: * 101: * @param encodingAlpha Whether the encoder should encode alpha 102: * transparency. 103: */ 104: public void setEncodingAlpha(boolean encodingAlpha); 105: 106: }