Class XbmImageParser
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleandumpImageFile(PrintWriter pw, ByteSource byteSource) Writes the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriterprotected String[]Gets an array of all accepted extensionsprotected ImageFormat[]Gets an array of ImageFormat objects describing all accepted typesfinal BufferedImagegetBufferedImage(ByteSource byteSource, XbmImagingParameters params) Gets a buffered image specified by the byte source (for sources that specify multiple images, choice of which image is returned is implementation dependent).Gets the default extension for the format specified by an implementation of ImageParser.Gets a default parameters instance for this parser.byte[]getIccProfileBytes(ByteSource byteSource, XbmImagingParameters params) Gets an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource.getImageInfo(ByteSource byteSource, XbmImagingParameters params) Gets image information from the specified ByteSource.getImageSize(ByteSource byteSource, XbmImagingParameters params) Gets the size of the image described by the specified ByteSource.getMetadata(ByteSource byteSource, XbmImagingParameters params) Gets image metadata from the specified byte source.getName()Gets a descriptive name for the implementation of an ImageParser.voidwriteImage(BufferedImage src, OutputStream os, XbmImagingParameters params) Writes the content of a BufferedImage to the specified output stream.Methods inherited from class org.apache.commons.imaging.AbstractImageParsercanAcceptExtension, canAcceptExtension, canAcceptType, dumpImageFile, dumpImageFile, dumpImageFile, getAllBufferedImages, getAllBufferedImages, getAllBufferedImages, getAllImageParsers, getBufferedImage, getBufferedImage, getBufferedImageFactory, getFormatCompliance, getFormatCompliance, getFormatCompliance, getIccProfileBytes, getIccProfileBytes, getIccProfileBytes, getIccProfileBytes, getImageInfo, getImageInfo, getImageInfo, getImageSize, getImageSize, getImageSize, getImageSize, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataMethods inherited from class org.apache.commons.imaging.common.BinaryFileParserdebugNumber, debugNumber, getByteOrder, setByteOrder
- 
Constructor Details- 
XbmImageParserpublic XbmImageParser()Constructs a new instance with the big-endian byte order.
 
- 
- 
Method Details- 
dumpImageFilepublic boolean dumpImageFile(PrintWriter pw, ByteSource byteSource) throws ImagingException, IOException Description copied from class:AbstractImageParserWrites the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter- Overrides:
- dumpImageFilein class- AbstractImageParser<XbmImagingParameters>
- 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.
 
- 
getAcceptedExtensionsDescription copied from class:AbstractImageParserGets an array of all accepted extensions- Specified by:
- getAcceptedExtensionsin class- AbstractImageParser<XbmImagingParameters>
- Returns:
- A valid array of one or more elements.
 
- 
getAcceptedTypesDescription copied from class:AbstractImageParserGets an array of ImageFormat objects describing all accepted types- Specified by:
- getAcceptedTypesin class- AbstractImageParser<XbmImagingParameters>
- Returns:
- A valid array of one or more elements.
 
- 
getBufferedImagepublic final BufferedImage getBufferedImage(ByteSource byteSource, XbmImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserGets 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:
- getBufferedImagein class- AbstractImageParser<XbmImagingParameters>
- 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.
 
- 
getDefaultExtensionDescription copied from class:AbstractImageParserGets 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:
- getDefaultExtensionin class- AbstractImageParser<XbmImagingParameters>
- Returns:
- A valid string.
 
- 
getDefaultParametersDescription copied from class:AbstractImageParserGets a default parameters instance for this parser.- Specified by:
- getDefaultParametersin class- AbstractImageParser<XbmImagingParameters>
- Returns:
- default parameters instance
 
- 
getIccProfileBytespublic byte[] getIccProfileBytes(ByteSource byteSource, XbmImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserGets 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:
- getIccProfileBytesin class- AbstractImageParser<XbmImagingParameters>
- 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.
 
- 
getImageInfopublic ImageInfo getImageInfo(ByteSource byteSource, XbmImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserGets 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:
- getImageInfoin class- AbstractImageParser<XbmImagingParameters>
- 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.
 
- 
getImageSizepublic Dimension getImageSize(ByteSource byteSource, XbmImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserGets the size of the image described by the specified ByteSource.- Specified by:
- getImageSizein class- AbstractImageParser<XbmImagingParameters>
- 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.
 
- 
getMetadatapublic ImageMetadata getMetadata(ByteSource byteSource, XbmImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserGets 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:
- getMetadatain class- AbstractImageParser<XbmImagingParameters>
- 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.
 
- 
getNameDescription copied from class:AbstractImageParserGets a descriptive name for the implementation of an ImageParser.- Specified by:
- getNamein class- AbstractImageParser<XbmImagingParameters>
- Returns:
- a valid, subject-matter-specific string.
 
- 
writeImagepublic void writeImage(BufferedImage src, OutputStream os, XbmImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserWrites 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:
- writeImagein class- AbstractImageParser<XbmImagingParameters>
- 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.
 
 
-