Interface ImageDecoder

All Known Implementing Classes:
ImageDecoderImpl, PNGImageDecoder, TIFFImageDecoder

public interface ImageDecoder
An interface describing objects that transform an InputStream into a BufferedImage or Raster.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a Raster that contains the decoded contents of the SeekableStream associated with this ImageDecoder.
    decodeAsRaster(int page)
    Returns a Raster that contains the decoded contents of the SeekableStream associated with this ImageDecoder.
    Returns a RenderedImage that contains the decoded contents of the SeekableStream associated with this ImageDecoder.
    Returns a RenderedImage that contains the decoded contents of the SeekableStream associated with this ImageDecoder.
    Returns the SeekableStream associated with this ImageDecoder.
    int
    Returns the number of pages present in the current stream.
    Returns the current parameters as an instance of the ImageDecodeParam interface.
    void
    Sets the current parameters to an instance of the ImageDecodeParam interface.
  • Method Details

    • getParam

      ImageDecodeParam getParam()
      Returns the current parameters as an instance of the ImageDecodeParam interface. Concrete implementations of this interface will return corresponding concrete implementations of the ImageDecodeParam interface. For example, a JPEGImageDecoder will return an instance of JPEGDecodeParam.
    • setParam

      void setParam(ImageDecodeParam param)
      Sets the current parameters to an instance of the ImageDecodeParam interface. Concrete implementations of ImageDecoder may throw a RuntimeException if the param argument is not an instance of the appropriate subclass or subinterface. For example, a JPEGImageDecoder will expect param to be an instance of JPEGDecodeParam.
    • getInputStream

      SeekableStream getInputStream()
      Returns the SeekableStream associated with this ImageDecoder.
    • getNumPages

      int getNumPages() throws IOException
      Returns the number of pages present in the current stream.
      Throws:
      IOException
    • decodeAsRaster

      Raster decodeAsRaster() throws IOException
      Returns a Raster that contains the decoded contents of the SeekableStream associated with this ImageDecoder. Only the first page of a multi-page image is decoded.
      Throws:
      IOException
    • decodeAsRaster

      Raster decodeAsRaster(int page) throws IOException
      Returns a Raster that contains the decoded contents of the SeekableStream associated with this ImageDecoder. The given page of a multi-page image is decoded. If the page does not exist, an IOException will be thrown. Page numbering begins at zero.
      Parameters:
      page - The page to be decoded.
      Throws:
      IOException
    • decodeAsRenderedImage

      RenderedImage decodeAsRenderedImage() throws IOException
      Returns a RenderedImage that contains the decoded contents of the SeekableStream associated with this ImageDecoder. Only the first page of a multi-page image is decoded.
      Throws:
      IOException
    • decodeAsRenderedImage

      RenderedImage decodeAsRenderedImage(int page) throws IOException
      Returns a RenderedImage that contains the decoded contents of the SeekableStream associated with this ImageDecoder. The given page of a multi-page image is decoded. If the page does not exist, an IOException will be thrown. Page numbering begins at zero.
      Parameters:
      page - The page to be decoded.
      Throws:
      IOException