Class JpegImageParser
- java.lang.Object
-
- org.apache.commons.imaging.common.BinaryFileParser
-
- org.apache.commons.imaging.ImageParser
-
- org.apache.commons.imaging.formats.jpeg.JpegImageParser
-
- All Implemented Interfaces:
XmpEmbeddable
public class JpegImageParser extends ImageParser implements XmpEmbeddable
-
-
Constructor Summary
Constructors Constructor Description JpegImageParser()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
dumpImageFile(PrintWriter pw, ByteSource byteSource)
Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriterprotected String[]
getAcceptedExtensions()
Get an array of all accepted extensionsprotected ImageFormat[]
getAcceptedTypes()
Get an array of ImageFormat objects describing all accepted typesBufferedImage
getBufferedImage(ByteSource byteSource, Map<String,Object> 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).String
getDefaultExtension()
Get the default extension for the format specified by an implementation of ImageParser.TiffImageMetadata
getExifMetadata(ByteSource byteSource, Map<String,Object> params)
byte[]
getExifRawData(ByteSource byteSource)
byte[]
getICCProfileBytes(ByteSource byteSource, Map<String,Object> params)
Get an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource.ImageInfo
getImageInfo(ByteSource byteSource, Map<String,Object> params)
Get image information from the specified ByteSource.Dimension
getImageSize(ByteSource byteSource, Map<String,Object> params)
Get the size of the image described by the specified ByteSource.ImageMetadata
getMetadata(ByteSource byteSource, Map<String,Object> params)
Get image metadata from the specified byte source.String
getName()
Get a descriptive name for the implementation of an ImageParser.JpegPhotoshopMetadata
getPhotoshopMetadata(ByteSource byteSource, Map<String,Object> params)
String
getXmpXml(ByteSource byteSource, Map<String,Object> params)
Extracts embedded XML metadata as XML string.boolean
hasExifSegment(ByteSource byteSource)
boolean
hasIptcSegment(ByteSource byteSource)
boolean
hasXmpSegment(ByteSource byteSource)
static boolean
isExifAPP1Segment(GenericSegment segment)
List<Segment>
readSegments(ByteSource byteSource, int[] markers, boolean returnAfterFirst)
List<Segment>
readSegments(ByteSource byteSource, int[] markers, boolean returnAfterFirst, boolean readEverything)
-
Methods inherited from class org.apache.commons.imaging.ImageParser
canAcceptExtension, 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, getMetadata, isStrict, writeImage
-
Methods inherited from class org.apache.commons.imaging.common.BinaryFileParser
debugNumber, debugNumber, getByteOrder, setByteOrder
-
-
-
-
Method Detail
-
getAcceptedTypes
protected ImageFormat[] getAcceptedTypes()
Description copied from class:ImageParser
Get an array of ImageFormat objects describing all accepted types- Specified by:
getAcceptedTypes
in classImageParser
- Returns:
- A valid array of one or more elements.
-
getName
public String getName()
Description copied from class:ImageParser
Get a descriptive name for the implementation of an ImageParser.- Specified by:
getName
in classImageParser
- Returns:
- a valid, subject-matter-specific string.
-
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 classImageParser
- Returns:
- A valid string.
-
getAcceptedExtensions
protected String[] getAcceptedExtensions()
Description copied from class:ImageParser
Get an array of all accepted extensions- Specified by:
getAcceptedExtensions
in classImageParser
- Returns:
- A valid array of one or more elements.
-
getBufferedImage
public final BufferedImage getBufferedImage(ByteSource byteSource, Map<String,Object> 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 classImageParser
- 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:
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.
-
readSegments
public List<Segment> readSegments(ByteSource byteSource, int[] markers, boolean returnAfterFirst, boolean readEverything) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
readSegments
public List<Segment> readSegments(ByteSource byteSource, int[] markers, boolean returnAfterFirst) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
getICCProfileBytes
public byte[] getICCProfileBytes(ByteSource byteSource, Map<String,Object> 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 classImageParser
- 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.
-
getMetadata
public ImageMetadata getMetadata(ByteSource byteSource, Map<String,Object> 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 classImageParser
- 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.
-
isExifAPP1Segment
public static boolean isExifAPP1Segment(GenericSegment segment)
-
getExifMetadata
public TiffImageMetadata getExifMetadata(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
getExifRawData
public byte[] getExifRawData(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
hasExifSegment
public boolean hasExifSegment(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
hasIptcSegment
public boolean hasIptcSegment(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
hasXmpSegment
public boolean hasXmpSegment(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
getXmpXml
public String getXmpXml(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
Extracts embedded XML metadata as XML string.- Specified by:
getXmpXml
in interfaceXmpEmbeddable
- 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:
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.
-
getPhotoshopMetadata
public JpegPhotoshopMetadata getPhotoshopMetadata(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
- Throws:
ImageReadException
IOException
-
getImageSize
public Dimension getImageSize(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
Description copied from class:ImageParser
Get the size of the image described by the specified ByteSource.- Specified by:
getImageSize
in classImageParser
- 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:
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.
-
getImageInfo
public ImageInfo getImageInfo(ByteSource byteSource, Map<String,Object> 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 classImageParser
- 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:
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.
-
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 classImageParser
- Parameters:
pw
- print writer used for writing the ImageInfobyteSource
- 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.
-
-