org.jfree.chart.encoders

Interface ImageEncoder

public interface ImageEncoder

Interface for abstracting different types of image encoders.
Method Summary
byte[]encode(BufferedImage bufferedImage)
Encodes an image in a particular format.
voidencode(BufferedImage bufferedImage, OutputStream outputStream)
Encodes an image in a particular format and writes it to an OutputStream.
floatgetQuality()
Get the quality of the image encoding.
booleanisEncodingAlpha()
Get whether the encoder should encode alpha transparency.
voidsetEncodingAlpha(boolean encodingAlpha)
Set whether the encoder should encode alpha transparency (not supported by all ImageEncoders).
voidsetQuality(float quality)
Set the quality of the image encoding (not supported by all ImageEncoders).

Method Detail

encode

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

Parameters: bufferedImage The image to be encoded.

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

Throws: IOException

encode

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

Parameters: bufferedImage The image to be encoded. outputStream The OutputStream to write the encoded image to.

Throws: IOException

getQuality

public float getQuality()
Get the quality of the image encoding.

Returns: A float representing the quality.

isEncodingAlpha

public boolean isEncodingAlpha()
Get whether the encoder should encode alpha transparency.

Returns: Whether the encoder is encoding alpha transparency.

setEncodingAlpha

public void setEncodingAlpha(boolean encodingAlpha)
Set whether the encoder should encode alpha transparency (not supported by all ImageEncoders).

Parameters: encodingAlpha Whether the encoder should encode alpha transparency.

setQuality

public void setQuality(float quality)
Set the quality of the image encoding (not supported by all ImageEncoders).

Parameters: quality A float representing the quality.