Class PcxImageParser

    • Constructor Detail

      • PcxImageParser

        public PcxImageParser()
    • Method Detail

      • getDefaultExtension

        public String getDefaultExtension()
        Description copied from class: ImageParser
        Get the default extension for the format specified by an implementation of ImageParser. Some parsers can support more than one extension (i.e. .JPEG, .JPG; .TIF, .TIFF, etc.).
        Specified by:
        getDefaultExtension in class ImageParser<PcxImagingParameters>
        Returns:
        A valid string.
      • getMetadata

        public ImageMetadata getMetadata​(ByteSource byteSource,
                                         PcxImagingParameters params)
                                  throws ImageReadException,
                                         IOException
        Description copied from class: ImageParser
        Get image metadata from the specified byte source. Format-specific ImageParser implementations are expected to return a valid IImageMetadata object or to throw an ImageReadException if unable to process the specified byte source.

        The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

        Specified by:
        getMetadata in class ImageParser<PcxImagingParameters>
        Parameters:
        byteSource - A valid byte source.
        params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).
        Returns:
        A valid, potentially subject-matter-specific implementation of the IImageMetadata interface describing the content extracted from the source content.
        Throws:
        ImageReadException - In the event that the ByteSource content does not conform to the format of the specific parser implementation.
        IOException - In the event of unsuccessful data read operation.
      • getImageInfo

        public ImageInfo getImageInfo​(ByteSource byteSource,
                                      PcxImagingParameters params)
                               throws ImageReadException,
                                      IOException
        Description copied from class: ImageParser
        Get image information from the specified ByteSource. Format-specific ImageParser implementations are expected to return a valid ImageInfo object or to throw an ImageReadException if unable to process the specified data.

        The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

        Specified by:
        getImageInfo in class ImageParser<PcxImagingParameters>
        Parameters:
        byteSource - A valid ByteSource object
        params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).
        Returns:
        A valid image information object describing the content extracted from the specified data.
        Throws:
        ImageReadException - In the event that the specified content does not conform to the format of the specific parser implementation.
        IOException - In the event of unsuccessful data access operation.
      • getICCProfileBytes

        public byte[] getICCProfileBytes​(ByteSource byteSource,
                                         PcxImagingParameters params)
                                  throws ImageReadException,
                                         IOException
        Description copied from class: ImageParser
        Get an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource. Not all formats support ICC profiles.
        Specified by:
        getICCProfileBytes in class ImageParser<PcxImagingParameters>
        Parameters:
        byteSource - A valid ByteSource.
        params - Optional instructions for special-handling or interpretation of the input data.
        Returns:
        If available, a valid array of bytes; otherwise, a null
        Throws:
        ImageReadException - In the event that the specified content does not conform to the format of the specific parser implementation.
        IOException - In the event of unsuccessful read or access operation.
      • dumpImageFile

        public boolean dumpImageFile​(PrintWriter pw,
                                     ByteSource byteSource)
                              throws ImageReadException,
                                     IOException
        Description copied from class: ImageParser
        Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter
        Overrides:
        dumpImageFile in class ImageParser<PcxImagingParameters>
        Parameters:
        pw - print writer used for writing the ImageInfo
        byteSource - A valid byte source.
        Returns:
        A valid PrintWriter.
        Throws:
        ImageReadException - In the event that the specified content does not conform to the format of the specific parser implementation.
        IOException - In the event of unsuccessful read or access operation.
      • getBufferedImage

        public final BufferedImage getBufferedImage​(ByteSource byteSource,
                                                    PcxImagingParameters params)
                                             throws ImageReadException,
                                                    IOException
        Description copied from class: ImageParser
        Gets a buffered image specified by the byte source (for sources that specify multiple images, choice of which image is returned is implementation dependent).
        Specified by:
        getBufferedImage in class ImageParser<PcxImagingParameters>
        Parameters:
        byteSource - A valid instance of ByteSource
        params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).
        Returns:
        A valid instance of BufferedImage.
        Throws:
        ImageReadException - In the event that the specified content does not conform to the format of the specific parser implementation.
        IOException - In the event of unsuccessful read or access operation.
      • writeImage

        public void writeImage​(BufferedImage src,
                               OutputStream os,
                               PcxImagingParameters params)
                        throws ImageWriteException,
                               IOException
        Description copied from class: ImageParser
        Writes the content of a BufferedImage to the specified output stream.

        The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will support this capability. Currently, some of the parsers do not check for null arguments.

        Overrides:
        writeImage in class ImageParser<PcxImagingParameters>
        Parameters:
        src - An image giving the source content for output
        os - A valid output stream for storing the formatted image
        params - optional parameters, defining format-specific instructions for output (such as selections for data compression, color models, etc.)
        Throws:
        ImageWriteException - In the event that the output format cannot handle the input image or invalid params are specified.
        IOException - In the event of an write error from the output stream.