Interface ImageEncoder

All Known Implementing Classes:
JpegImageEncoder, PngEncoder

public interface ImageEncoder
A image encoder. The encoder's encodeImage method must be synchronized in some way, so that multiple calls from multiple threads do not interact with each other.
Author:
Thomas Morgner
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    encodeImage(java.awt.Image image, java.io.OutputStream outputStream, float quality, boolean encodeAlpha)
    Encodes the given image using the given encoder-specific quality and alpha-channel settings and writes the encoded image-data to the given stream.
    java.lang.String
    Returns the mime-type of the encoded data.
  • Method Details

    • encodeImage

      void encodeImage(java.awt.Image image, java.io.OutputStream outputStream, float quality, boolean encodeAlpha) throws java.io.IOException, UnsupportedEncoderException
      Encodes the given image using the given encoder-specific quality and alpha-channel settings and writes the encoded image-data to the given stream.
      Parameters:
      image - the image to be encoded.
      outputStream - the output stream, where to write the image data to.
      quality - the quality of the encoding.
      encodeAlpha - a flag controlling whether the alpha-channel should be encoded as well.
      Throws:
      java.io.IOException - if there was an IO error while generating or writing the image data.
      UnsupportedEncoderException - if the encoder is not supported.
    • getMimeType

      java.lang.String getMimeType()
      Returns the mime-type of the encoded data.
      Returns:
      the mime-type.