| java.lang.Object
 org.apache.xmlgraphics.image.codec.util.ImageDecoderImpl
All known Subclasses: org.apache.xmlgraphics.image.codec.png.PNGImageDecoder, org.apache.xmlgraphics.image.codec.tiff.TIFFImageDecoder,
| ImageDecoderImpl | | abstract public class ImageDecoderImpl implements ImageDecoder(Code) | | A partial implementation of the ImageDecoder interface
useful for subclassing.
|
| Method Summary | |
| public Raster | decodeAsRaster()
Returns a Raster that contains the decoded
contents of the SeekableStream associated
with this ImageDecoder. | | public Raster | decodeAsRaster(int page)
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. | | public RenderedImage | decodeAsRenderedImage()
Returns a RenderedImage that contains the decoded
contents of the SeekableStream associated
with this ImageDecoder. | | abstract public RenderedImage | decodeAsRenderedImage(int page)
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. | | public SeekableStream | getInputStream()
Returns the SeekableStream associated with
this ImageDecoder. | | public int | getNumPages()
Returns the number of pages present in the current stream.
By default, the return value is 1. | | public ImageDecodeParam | getParam()
Returns the current parameters as an instance of the
ImageDecodeParam interface. | | public void | setParam(ImageDecodeParam param)
Sets the current parameters to an instance of the
ImageDecodeParam interface. |
| ImageDecoderImpl | | public ImageDecoderImpl(SeekableStream input, ImageDecodeParam param)(Code) | | Constructs an ImageDecoderImpl with a given
SeekableStream and ImageDecodeParam
instance.
|
| ImageDecoderImpl | | public ImageDecoderImpl(InputStream input, ImageDecodeParam param)(Code) | | Constructs an ImageDecoderImpl with a given
InputStream and ImageDecodeParam
instance. The input parameter will be used to
construct a ForwardSeekableStream; if the ability
to seek backwards is required, the caller should construct
an instance of SeekableStream and
make use of the other contructor.
|
| decodeAsRaster | | public Raster decodeAsRaster() throws IOException(Code) | | 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.
|
| decodeAsRaster | | public Raster decodeAsRaster(int page) throws IOException(Code) | | 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. |
| decodeAsRenderedImage | | public RenderedImage decodeAsRenderedImage() throws IOException(Code) | | 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.
|
| decodeAsRenderedImage | | abstract public RenderedImage decodeAsRenderedImage(int page) throws IOException(Code) | | 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. |
| getInputStream | | public SeekableStream getInputStream()(Code) | | Returns the SeekableStream associated with
this ImageDecoder.
|
| getNumPages | | public int getNumPages() throws IOException(Code) | | Returns the number of pages present in the current stream.
By default, the return value is 1. Subclasses that deal with
multi-page formats should override this method.
|
| getParam | | public ImageDecodeParam getParam()(Code) | | 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 | | public void setParam(ImageDecodeParam param)(Code) | | 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.
|
|
|
