Package com.sun.media.imageioimpl.plugins.jpeg2000

Class J2KImageWriter

  • All Implemented Interfaces:
    javax.imageio.ImageTranscoder
    public class J2KImageWriter
extends javax.imageio.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:
    J2KImageWriteParam

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.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​(javax.imageio.spi.ImageWriterSpi originator)
      Constructs J2KImageWriter based on the provided ImageWriterSpi.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abort()  
      boolean canWriteRasters()  
      javax.imageio.metadata.IIOMetadata convertImageMetadata​(javax.imageio.metadata.IIOMetadata inData, javax.imageio.ImageTypeSpecifier imageType, javax.imageio.ImageWriteParam param)  
      javax.imageio.metadata.IIOMetadata convertStreamMetadata​(javax.imageio.metadata.IIOMetadata inData, javax.imageio.ImageWriteParam param)  
      boolean getAbortRequest()
      This method wraps the protected method abortRequested to allow the abortions be monitored by J2KRenderedImage.
      javax.imageio.metadata.IIOMetadata getDefaultImageMetadata​(javax.imageio.ImageTypeSpecifier imageType, javax.imageio.ImageWriteParam param)  
      javax.imageio.metadata.IIOMetadata getDefaultStreamMetadata​(javax.imageio.ImageWriteParam param)  
      javax.imageio.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​(java.lang.Object output)  
      void write​(javax.imageio.metadata.IIOMetadata streamMetadata, javax.imageio.IIOImage image, javax.imageio.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 java.lang.String WRITE_ABORTED
        When the writing is aborted, RenderedImageSrc throws a RuntimeException.

    • Constructor Detail

      • J2KImageWriter

        public J2KImageWriter​(javax.imageio.spi.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​(java.lang.Object output)
        Overrides:
        setOutput in class javax.imageio.ImageWriter

      • getDefaultWriteParam

        public javax.imageio.ImageWriteParam getDefaultWriteParam()
        Overrides:
        getDefaultWriteParam in class javax.imageio.ImageWriter

      • getDefaultStreamMetadata

        public javax.imageio.metadata.IIOMetadata getDefaultStreamMetadata​(javax.imageio.ImageWriteParam param)
        Specified by:
        getDefaultStreamMetadata in class javax.imageio.ImageWriter

      • getDefaultImageMetadata

        public javax.imageio.metadata.IIOMetadata getDefaultImageMetadata​(javax.imageio.ImageTypeSpecifier imageType,
                                                                  javax.imageio.ImageWriteParam param)
        Specified by:
        getDefaultImageMetadata in class javax.imageio.ImageWriter

      • convertStreamMetadata

        public javax.imageio.metadata.IIOMetadata convertStreamMetadata​(javax.imageio.metadata.IIOMetadata inData,
                                                                javax.imageio.ImageWriteParam param)
        Specified by:
        convertStreamMetadata in interface javax.imageio.ImageTranscoder
        Specified by:
        convertStreamMetadata in class javax.imageio.ImageWriter

      • convertImageMetadata

        public javax.imageio.metadata.IIOMetadata convertImageMetadata​(javax.imageio.metadata.IIOMetadata inData,
                                                               javax.imageio.ImageTypeSpecifier imageType,
                                                               javax.imageio.ImageWriteParam param)
        Specified by:
        convertImageMetadata in interface javax.imageio.ImageTranscoder
        Specified by:
        convertImageMetadata in class javax.imageio.ImageWriter

      • canWriteRasters

        public boolean canWriteRasters()
        Overrides:
        canWriteRasters in class javax.imageio.ImageWriter

      • write

        public void write​(javax.imageio.metadata.IIOMetadata streamMetadata,
                  javax.imageio.IIOImage image,
                  javax.imageio.ImageWriteParam param)
           throws java.io.IOException
        Specified by:
        write in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException

      • abort

        public void abort()
        Overrides:
        abort in class javax.imageio.ImageWriter

      • reset

        public void reset()
        Overrides:
        reset in class javax.imageio.ImageWriter

      • getAbortRequest

        public boolean getAbortRequest()
        This method wraps the protected method abortRequested to allow the abortions be monitored by J2KRenderedImage.