org.jfree.chart.encoders

Class SunJPEGEncoderAdapter

public class SunJPEGEncoderAdapter extends Object implements ImageEncoder

Adapter class for the Sun JPEG Encoder. The ImageEncoderFactory will only return a reference to this class by default if the library has been compiled under a JDK 1.4+ and is being run using a JRE 1.4+.
Constructor Summary
SunJPEGEncoderAdapter()
Creates a new SunJPEGEncoderAdapter instance.
Method Summary
byte[]encode(BufferedImage bufferedImage)
Encodes an image in JPEG format.
voidencode(BufferedImage bufferedImage, OutputStream outputStream)
Encodes an image in JPEG format and writes it to an output stream.
floatgetQuality()
Returns the quality of the image encoding, which is a number in the range 0.0f to 1.0f (higher values give better quality output, but larger file sizes).
booleanisEncodingAlpha()
Returns false always, indicating that this encoder does not encode alpha transparency.
voidsetEncodingAlpha(boolean encodingAlpha)
Set whether the encoder should encode alpha transparency (this is not supported for JPEG, so this method does nothing).
voidsetQuality(float quality)
Set the quality of the image encoding.

Constructor Detail

SunJPEGEncoderAdapter

public SunJPEGEncoderAdapter()
Creates a new SunJPEGEncoderAdapter instance.

Method Detail

encode

public byte[] encode(BufferedImage bufferedImage)
Encodes an image in JPEG format.

Parameters: bufferedImage the image to be encoded (null not permitted).

Returns: The byte[] that is the encoded image.

Throws: IOException if there is an I/O problem. NullPointerException if bufferedImage is null.

encode

public void encode(BufferedImage bufferedImage, OutputStream outputStream)
Encodes an image in JPEG format and writes it to an output stream.

Parameters: bufferedImage the image to be encoded (null not permitted). outputStream the OutputStream to write the encoded image to (null not permitted).

Throws: IOException if there is an I/O problem. NullPointerException if bufferedImage is null.

getQuality

public float getQuality()
Returns the quality of the image encoding, which is a number in the range 0.0f to 1.0f (higher values give better quality output, but larger file sizes). The default value is 0.95f.

Returns: A float representing the quality, in the range 0.0f to 1.0f.

See Also: SunJPEGEncoderAdapter

isEncodingAlpha

public boolean isEncodingAlpha()
Returns false always, indicating that this encoder does not encode alpha transparency.

Returns: false.

setEncodingAlpha

public void setEncodingAlpha(boolean encodingAlpha)
Set whether the encoder should encode alpha transparency (this is not supported for JPEG, so this method does nothing).

Parameters: encodingAlpha ignored.

setQuality

public void setQuality(float quality)
Set the quality of the image encoding.

Parameters: quality A float representing the quality (in the range 0.0f to 1.0f).

See Also: getQuality

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.