Package com.github.jaiimageio.impl.plugins.pnm

Class PNMImageWriter

  • All Implemented Interfaces:
    javax.imageio.ImageTranscoder
    public class PNMImageWriter
extends javax.imageio.ImageWriter
    The Java Image IO plugin writer for encoding a binary RenderedImage into a PNM format. The encoding process may clip, subsample using the parameters specified in the ImageWriteParam.
    See Also:
    com.github.jaiimageio.plugins.PNMImageWriteParam

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String COMMENT  
      private static byte[] lineSeparator  
      private int maxValue  
      private static int PBM_ASCII  
      private static int PBM_RAW  
      private static int PGM_ASCII  
      private static int PGM_RAW  
      private static int PPM_ASCII  
      private static int PPM_RAW  
      private static int SPACE  
      private javax.imageio.stream.ImageOutputStream stream
      The output stream to write into
      private int variant  

      • Fields inherited from class javax.imageio.ImageWriter

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

    • Constructor Summary

      Constructors 
      Constructor Description
      PNMImageWriter​(javax.imageio.spi.ImageWriterSpi originator)
      Constructs PNMImageWriter based on the provided ImageWriterSpi.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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)  
      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()  
      private boolean isRaw​(int v)
      Returns true if file variant is raw format, false if ASCII.
      void reset()  
      void setOutput​(java.lang.Object output)  
      void write​(javax.imageio.metadata.IIOMetadata streamMetadata, javax.imageio.IIOImage image, javax.imageio.ImageWriteParam param)  
      private void writeByte​(javax.imageio.stream.ImageOutputStream output, byte b)
      Writes a byte to the output in ASCII format.
      private void writeInteger​(javax.imageio.stream.ImageOutputStream output, int i)
      Writes an integer to the output in ASCII format.

      • Methods inherited from class javax.imageio.ImageWriter

        abort, 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

    • Constructor Detail

      • PNMImageWriter

        public PNMImageWriter​(javax.imageio.spi.ImageWriterSpi originator)
        Constructs PNMImageWriter based on the provided ImageWriterSpi.

    • Method Detail

      • 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

      • reset

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

      • writeInteger

        private void writeInteger​(javax.imageio.stream.ImageOutputStream output,
                          int i)
                   throws java.io.IOException
        Writes an integer to the output in ASCII format.
        Throws:
        java.io.IOException

      • writeByte

        private void writeByte​(javax.imageio.stream.ImageOutputStream output,
                       byte b)
                throws java.io.IOException
        Writes a byte to the output in ASCII format.
        Throws:
        java.io.IOException

      • isRaw

        private boolean isRaw​(int v)
        Returns true if file variant is raw format, false if ASCII.