org.jfree.chart.encoders

Class EncoderUtil


public class EncoderUtil
extends java.lang.Object

A collection of utility methods for encoding images and returning them as a byte[] or writing them directly to an OutputStream.

Method Summary

static byte[]
encode(BufferedImage image, String format)
Encode the image in a specific format.
static byte[]
encode(BufferedImage image, String format, boolean encodeAlpha)
Encode the image in a specific format.
static byte[]
encode(BufferedImage image, String format, float quality)
Encode the image in a specific format.
static byte[]
encode(BufferedImage image, String format, float quality, boolean encodeAlpha)
Encode the image in a specific format.
static void
writeBufferedImage(BufferedImage image, String format, OutputStream outputStream)
Encode the image in a specific format and write it to an OutputStream.
static void
writeBufferedImage(BufferedImage image, String format, OutputStream outputStream, boolean encodeAlpha)
Encode the image in a specific format and write it to an OutputStream.
static void
writeBufferedImage(BufferedImage image, String format, OutputStream outputStream, float quality)
Encode the image in a specific format and write it to an OutputStream.
static void
writeBufferedImage(BufferedImage image, String format, OutputStream outputStream, float quality, boolean encodeAlpha)
Encode the image in a specific format and write it to an OutputStream.

Method Details

encode

public static byte[] encode(BufferedImage image,
                            String format)
            throws IOException
Encode the image in a specific format.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
Returns:
The byte[] that is the encoded image.

encode

public static byte[] encode(BufferedImage image,
                            String format,
                            boolean encodeAlpha)
            throws IOException
Encode the image in a specific format.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
encodeAlpha - Whether to encode alpha transparency (not supported by all ImageEncoders).
Returns:
The byte[] that is the encoded image.

encode

public static byte[] encode(BufferedImage image,
                            String format,
                            float quality)
            throws IOException
Encode the image in a specific format.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
quality - The quality to use for the image encoding (not supported by all ImageEncoders).
Returns:
The byte[] that is the encoded image.

encode

public static byte[] encode(BufferedImage image,
                            String format,
                            float quality,
                            boolean encodeAlpha)
            throws IOException
Encode the image in a specific format.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
quality - The quality to use for the image encoding (not supported by all ImageEncoders).
encodeAlpha - Whether to encode alpha transparency (not supported by all ImageEncoders).
Returns:
The byte[] that is the encoded image.

writeBufferedImage

public static void writeBufferedImage(BufferedImage image,
                                      String format,
                                      OutputStream outputStream)
            throws IOException
Encode the image in a specific format and write it to an OutputStream.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
outputStream - The OutputStream to write the encoded image to.

writeBufferedImage

public static void writeBufferedImage(BufferedImage image,
                                      String format,
                                      OutputStream outputStream,
                                      boolean encodeAlpha)
            throws IOException
Encode the image in a specific format and write it to an OutputStream.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
outputStream - The OutputStream to write the encoded image to.
encodeAlpha - Whether to encode alpha transparency (not supported by all ImageEncoders).

writeBufferedImage

public static void writeBufferedImage(BufferedImage image,
                                      String format,
                                      OutputStream outputStream,
                                      float quality)
            throws IOException
Encode the image in a specific format and write it to an OutputStream.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
outputStream - The OutputStream to write the encoded image to.
quality - The quality to use for the image encoding (not supported by all ImageEncoders).

writeBufferedImage

public static void writeBufferedImage(BufferedImage image,
                                      String format,
                                      OutputStream outputStream,
                                      float quality,
                                      boolean encodeAlpha)
            throws IOException
Encode the image in a specific format and write it to an OutputStream.
Parameters:
image - The image to be encoded.
format - The ImageFormat to use.
outputStream - The OutputStream to write the encoded image to.
quality - The quality to use for the image encoding (not supported by all ImageEncoders).
encodeAlpha - Whether to encode alpha transparency (not supported by all ImageEncoders).