Class GifImageParser
- All Implemented Interfaces:
XmpEmbeddable<GifImagingParameters>
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new instance with the little-endian byte order. -
Method Summary
Modifier 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 typesgetAllBufferedImages(ByteSource byteSource) Gets all images specified by the byte source (some formats may include multiple images within a single data source).getBufferedImage(ByteSource byteSource, GifImagingParameters 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.getFormatCompliance(ByteSource byteSource) Determines the format compliance of the content of the supplied byte source based on rules provided by a specific implementation.byte[]getIccProfileBytes(ByteSource byteSource, GifImagingParameters 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, GifImagingParameters params) Gets image information from the specified ByteSource.getImageSize(ByteSource byteSource, GifImagingParameters params) Gets the size of the image described by the specified ByteSource.getMetadata(ByteSource byteSource, GifImagingParameters params) Gets image metadata from the specified byte source.getName()Gets a descriptive name for the implementation of an ImageParser.getXmpXml(ByteSource byteSource, XmpImagingParameters<GifImagingParameters> params) Extracts embedded XML metadata as XML string.voidwriteImage(BufferedImage src, OutputStream os, GifImagingParameters params) Writes the content of a BufferedImage to the specified output stream.Methods inherited from class org.apache.commons.imaging.AbstractImageParser
canAcceptExtension, canAcceptExtension, canAcceptType, dumpImageFile, dumpImageFile, dumpImageFile, getAllBufferedImages, getAllBufferedImages, getAllImageParsers, getBufferedImage, getBufferedImage, getBufferedImageFactory, 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.BinaryFileParser
debugNumber, debugNumber, getByteOrder, setByteOrder
-
Constructor Details
-
GifImageParser
public GifImageParser()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:AbstractImageParserWrites the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter- Overrides:
dumpImageFilein classAbstractImageParser<GifImagingParameters>- Parameters:
pw- print writer used for writing the ImageInfobyteSource- 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
Description copied from class:AbstractImageParserGets an array of all accepted extensions- Specified by:
getAcceptedExtensionsin classAbstractImageParser<GifImagingParameters>- Returns:
- A valid array of one or more elements.
-
getAcceptedTypes
Description copied from class:AbstractImageParserGets an array of ImageFormat objects describing all accepted types- Specified by:
getAcceptedTypesin classAbstractImageParser<GifImagingParameters>- Returns:
- A valid array of one or more elements.
-
getAllBufferedImages
public List<BufferedImage> getAllBufferedImages(ByteSource byteSource) throws ImagingException, IOException Description copied from class:AbstractImageParserGets all images specified by the byte source (some formats may include multiple images within a single data source).- Overrides:
getAllBufferedImagesin classAbstractImageParser<GifImagingParameters>- 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 BufferedImage getBufferedImage(ByteSource byteSource, GifImagingParameters 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 classAbstractImageParser<GifImagingParameters>- Parameters:
byteSource- A valid instance of ByteSourceparams- 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
Description 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 classAbstractImageParser<GifImagingParameters>- Returns:
- A valid string.
-
getDefaultParameters
Description copied from class:AbstractImageParserGets a default parameters instance for this parser.- Specified by:
getDefaultParametersin classAbstractImageParser<GifImagingParameters>- Returns:
- default parameters instance
-
getFormatCompliance
public FormatCompliance getFormatCompliance(ByteSource byteSource) throws ImagingException, IOException Description copied from class:AbstractImageParserDetermines the format compliance of the content of the supplied byte source based on rules provided by a specific implementation.- Overrides:
getFormatCompliancein classAbstractImageParser<GifImagingParameters>- Parameters:
byteSource- A valid instance of ByteSource- Returns:
- true if the content is format-compliant; otherwise, false
- Throws:
ImagingException- may be thrown by sub-classesIOException- may be thrown by sub-classes
-
getIccProfileBytes
public byte[] getIccProfileBytes(ByteSource byteSource, GifImagingParameters 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 classAbstractImageParser<GifImagingParameters>- 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, GifImagingParameters 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 classAbstractImageParser<GifImagingParameters>- Parameters:
byteSource- A valid ByteSource objectparams- 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, GifImagingParameters params) throws ImagingException, IOException Description copied from class:AbstractImageParserGets the size of the image described by the specified ByteSource.- Specified by:
getImageSizein classAbstractImageParser<GifImagingParameters>- 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, GifImagingParameters 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 classAbstractImageParser<GifImagingParameters>- 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
Description copied from class:AbstractImageParserGets a descriptive name for the implementation of an ImageParser.- Specified by:
getNamein classAbstractImageParser<GifImagingParameters>- Returns:
- a valid, subject-matter-specific string.
-
getXmpXml
public String getXmpXml(ByteSource byteSource, XmpImagingParameters<GifImagingParameters> params) throws ImagingException, IOException Extracts embedded XML metadata as XML string.- Specified by:
getXmpXmlin interfaceXmpEmbeddable<GifImagingParameters>- Parameters:
byteSource- File containing image data.params- Map of optional parameters, defined in ImagingConstants.- Returns:
- Xmp Xml as String, if present. Otherwise, returns 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.
-
writeImage
public void writeImage(BufferedImage src, OutputStream os, GifImagingParameters 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 classAbstractImageParser<GifImagingParameters>- Parameters:
src- An image giving the source content for outputos- A valid output stream for storing the formatted imageparams- 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.
-