Class DcxImageParser

java.lang.Object
org.apache.commons.imaging.common.BinaryFileParser
org.apache.commons.imaging.AbstractImageParser<PcxImagingParameters>
org.apache.commons.imaging.formats.dcx.DcxImageParser
public class DcxImageParser extends AbstractImageParser<PcxImagingParameters>

  • Field Details

    • DEFAULT_EXTENSION

      private static final String DEFAULT_EXTENSION

    • ACCEPTED_EXTENSIONS

      private static final String[] ACCEPTED_EXTENSIONS

  • Constructor Details

    • DcxImageParser

      public DcxImageParser()
      Constructs a new instance with the little-endian byte order.

  • Method Details

    • dumpImageFile

      public boolean dumpImageFile(PrintWriter pw, ByteSource byteSource) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      Writes the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter
      Overrides:
      dumpImageFile in class AbstractImageParser<PcxImagingParameters>
      Parameters:
      pw - print writer used for writing the ImageInfo
      byteSource - A valid byte source.
      Returns:
      A valid PrintWriter.
      Throws:
      ImagingException - 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.

    • getAcceptedExtensions

      protected String[] getAcceptedExtensions()
      Description copied from class: AbstractImageParser
      Gets an array of all accepted extensions
      Specified by:
      getAcceptedExtensions in class AbstractImageParser<PcxImagingParameters>
      Returns:
      A valid array of one or more elements.

    • getAcceptedTypes

      protected ImageFormat[] getAcceptedTypes()
      Description copied from class: AbstractImageParser
      Gets an array of ImageFormat objects describing all accepted types
      Specified by:
      getAcceptedTypes in class AbstractImageParser<PcxImagingParameters>
      Returns:
      A valid array of one or more elements.

    • getAllBufferedImages

      public List<BufferedImage> getAllBufferedImages(ByteSource byteSource) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      Gets all images specified by the byte source (some formats may include multiple images within a single data source).
      Overrides:
      getAllBufferedImages in class AbstractImageParser<PcxImagingParameters>
      Parameters:
      byteSource - A valid instance of ByteSource.
      Returns:
      A valid (potentially empty) list of BufferedImage objects.
      Throws:
      ImagingException - 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 ImagingException, IOException
      Description copied from class: AbstractImageParser
      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 AbstractImageParser<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:
      ImagingException - 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.

    • getDefaultExtension

      public String getDefaultExtension()
      Description copied from class: AbstractImageParser
      Gets 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 AbstractImageParser<PcxImagingParameters>
      Returns:
      A valid string.

    • getDefaultParameters

      public PcxImagingParameters getDefaultParameters()
      Description copied from class: AbstractImageParser
      Gets a default parameters instance for this parser.
      Specified by:
      getDefaultParameters in class AbstractImageParser<PcxImagingParameters>
      Returns:
      default parameters instance

    • getIccProfileBytes

      public byte[] getIccProfileBytes(ByteSource byteSource, PcxImagingParameters params) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      Gets 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 AbstractImageParser<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:
      ImagingException - 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.

    • getImageInfo

      public ImageInfo getImageInfo(ByteSource byteSource, PcxImagingParameters params) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      Gets 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 AbstractImageParser<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:
      ImagingException - 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.

    • getImageSize

      public Dimension getImageSize(ByteSource byteSource, PcxImagingParameters params) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      Gets the size of the image described by the specified ByteSource.
      Specified by:
      getImageSize in class AbstractImageParser<PcxImagingParameters>
      Parameters:
      byteSource - A valid reference to a ByteSource.
      params - Optional instructions for special-handling or interpretation of the input data.
      Returns:
      A valid instance of Dimension.
      Throws:
      ImagingException - 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.

    • getMetadata

      public ImageMetadata getMetadata(ByteSource byteSource, PcxImagingParameters params) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      Gets 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 AbstractImageParser<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:
      ImagingException - 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.

    • getName

      public String getName()
      Description copied from class: AbstractImageParser
      Gets a descriptive name for the implementation of an ImageParser.
      Specified by:
      getName in class AbstractImageParser<PcxImagingParameters>
      Returns:
      a valid, subject-matter-specific string.

    • readDcxHeader

      private DcxImageParser.DcxHeader readDcxHeader(ByteSource byteSource) throws ImagingException, IOException
      Throws:
      ImagingException
      IOException

    • writeImage

      public void writeImage(BufferedImage src, OutputStream os, PcxImagingParameters params) throws ImagingException, IOException
      Description copied from class: AbstractImageParser
      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 AbstractImageParser<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:
      ImagingException - 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.