Package com.github.jaiimageio.jpeg2000.impl

Class J2KImageWriter

java.lang.Object

javax.imageio.ImageWriter

com.github.jaiimageio.jpeg2000.impl.J2KImageWriter

All Implemented Interfaces:

ImageTranscoder

public class J2KImageWriter
extends ImageWriter

The Java Image IO plugin writer for encoding a RenderedImage into a JPEG 2000 part 1 file (JP2) format. This writer has the capability to (1) Losslessly encode RenderedImages with an IndexColorModel (for example, bi-level or color indexed images). (2) Losslessly or lossy encode RenderedImage with a byte, short, ushort or integer types with band number upto 16384. (3) Encode an image with alpha channel. (4) Write the provided metadata into the code stream. It also can encode a raster wrapped in the provided IIOImage. The encoding process may re-tile image, clip, subsample, and select bands using the parameters specified in the ImageWriteParam.

See Also:

com.sun.media.imageio.plugins.J2KImageWriteParam

Field Summary

Fields

Modifier and Type	Field	Description
static String	WRITE_ABORTED	When the writing is aborted, RenderedImageSrc throws a RuntimeException.

Fields inherited from class javax.imageio.ImageWriter

availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor	Description
J2KImageWriter(ImageWriterSpi originator)	Constructs J2KImageWriter based on the provided ImageWriterSpi.

Method Summary

Modifier and Type	Method	Description
void	abort()
boolean	canWriteRasters()
IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)
IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)
boolean	getAbortRequest()	This method wraps the protected method abortRequested to allow the abortions be monitored by J2KRenderedImage.
IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param)
ImageWriteParam	getDefaultWriteParam()
void	processImageProgressWrapper(float percentageDone)	Wrapper for the protected method processImageProgress So it can be access from the classes which are not in ImageWriter hierachy.
void	reset()
void	setOutput(Object output)
void	write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param)

Methods inherited from class javax.imageio.ImageWriter

abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, canWriteSequence, clearAbortRequest, dispose, endInsertEmpty, endReplacePixels, endWriteEmpty, endWriteSequence, getAvailableLocales, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, prepareWriteSequence, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, setLocale, write, write, writeInsert, writeToSequence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WRITE_ABORTED

public static String WRITE_ABORTED

When the writing is aborted, RenderedImageSrc throws a RuntimeException.

Constructor Detail

J2KImageWriter

public J2KImageWriter(ImageWriterSpi originator)

Constructs J2KImageWriter based on the provided ImageWriterSpi.

Method Detail

processImageProgressWrapper

public void processImageProgressWrapper(float percentageDone)

Wrapper for the protected method processImageProgress So it can be access from the classes which are not in ImageWriter hierachy.

setOutput

public void setOutput(Object output)

Overrides:

setOutput in class ImageWriter

getDefaultWriteParam

public ImageWriteParam getDefaultWriteParam()

Overrides:

getDefaultWriteParam in class ImageWriter

getDefaultStreamMetadata

public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)

Specified by:

getDefaultStreamMetadata in class ImageWriter

getDefaultImageMetadata

public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType,
                                           ImageWriteParam param)

Specified by:

getDefaultImageMetadata in class ImageWriter

convertStreamMetadata

public IIOMetadata convertStreamMetadata(IIOMetadata inData,
                                         ImageWriteParam param)

Specified by:

convertStreamMetadata in interface ImageTranscoder

Specified by:

convertStreamMetadata in class ImageWriter

convertImageMetadata

public IIOMetadata convertImageMetadata(IIOMetadata inData,
                                        ImageTypeSpecifier imageType,
                                        ImageWriteParam param)

Specified by:

convertImageMetadata in interface ImageTranscoder

Specified by:

convertImageMetadata in class ImageWriter

canWriteRasters

public boolean canWriteRasters()

Overrides:

canWriteRasters in class ImageWriter

write

public void write(IIOMetadata streamMetadata,
                  IIOImage image,
                  ImageWriteParam param)
           throws IOException

Specified by:

write in class ImageWriter

Throws:

IOException

abort

public void abort()

Overrides:

abort in class ImageWriter

reset

public void reset()

Overrides:

reset in class ImageWriter

getAbortRequest

public boolean getAbortRequest()

This method wraps the protected method abortRequested to allow the abortions be monitored by J2KRenderedImage.