Class JpegImageParser
- java.lang.Object
-
- org.apache.commons.imaging.common.BinaryFileParser
-
- org.apache.commons.imaging.ImageParser<JpegImagingParameters>
-
- org.apache.commons.imaging.formats.jpeg.JpegImageParser
-
- All Implemented Interfaces:
XmpEmbeddable
public class JpegImageParser extends ImageParser<JpegImagingParameters> implements XmpEmbeddable
-
-
Constructor Summary
Constructors Constructor Description JpegImageParser()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleandumpImageFile(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 typesBufferedImagegetBufferedImage(ByteSource byteSource, JpegImagingParameters 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).StringgetDefaultExtension()Get the default extension for the format specified by an implementation of ImageParser.JpegImagingParametersgetDefaultParameters()Get a default parameters instance for this parser.TiffImageMetadatagetExifMetadata(ByteSource byteSource, TiffImagingParameters params)byte[]getExifRawData(ByteSource byteSource)byte[]getICCProfileBytes(ByteSource byteSource, JpegImagingParameters 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.ImageInfogetImageInfo(ByteSource byteSource, JpegImagingParameters params)Get image information from the specified ByteSource.DimensiongetImageSize(ByteSource byteSource, JpegImagingParameters params)Get the size of the image described by the specified ByteSource.ImageMetadatagetMetadata(ByteSource byteSource, JpegImagingParameters params)Get image metadata from the specified byte source.StringgetName()Get a descriptive name for the implementation of an ImageParser.JpegPhotoshopMetadatagetPhotoshopMetadata(ByteSource byteSource, JpegImagingParameters params)StringgetXmpXml(ByteSource byteSource, XmpImagingParameters params)Extracts embedded XML metadata as XML string.booleanhasExifSegment(ByteSource byteSource)booleanhasIptcSegment(ByteSource byteSource)booleanhasXmpSegment(ByteSource byteSource)static booleanisExifAPP1Segment(GenericSegment segment)List<Segment>readSegments(ByteSource byteSource, int[] markers, boolean returnAfterFirst)-
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, 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:ImageParserGet an array of ImageFormat objects describing all accepted types- Specified by:
getAcceptedTypesin classImageParser<JpegImagingParameters>- Returns:
- A valid array of one or more elements.
-
getDefaultParameters
public JpegImagingParameters getDefaultParameters()
Description copied from class:ImageParserGet a default parameters instance for this parser.- Specified by:
getDefaultParametersin classImageParser<JpegImagingParameters>- Returns:
- default parameters instance
-
getName
public String getName()
Description copied from class:ImageParserGet a descriptive name for the implementation of an ImageParser.- Specified by:
getNamein classImageParser<JpegImagingParameters>- Returns:
- a valid, subject-matter-specific string.
-
getDefaultExtension
public String getDefaultExtension()
Description copied from class:ImageParserGet 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 classImageParser<JpegImagingParameters>- Returns:
- A valid string.
-
getAcceptedExtensions
protected String[] getAcceptedExtensions()
Description copied from class:ImageParserGet an array of all accepted extensions- Specified by:
getAcceptedExtensionsin classImageParser<JpegImagingParameters>- Returns:
- A valid array of one or more elements.
-
getBufferedImage
public final BufferedImage getBufferedImage(ByteSource byteSource, JpegImagingParameters params) throws ImageReadException, IOException
Description copied from class:ImageParserGets 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 classImageParser<JpegImagingParameters>- 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) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
getICCProfileBytes
public byte[] getICCProfileBytes(ByteSource byteSource, JpegImagingParameters params) throws ImageReadException, IOException
Description copied from class:ImageParserGet 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 classImageParser<JpegImagingParameters>- 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, JpegImagingParameters params) throws ImageReadException, IOException
Description copied from class:ImageParserGet 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 classImageParser<JpegImagingParameters>- 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, TiffImagingParameters params) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
getExifRawData
public byte[] getExifRawData(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
hasExifSegment
public boolean hasExifSegment(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
hasIptcSegment
public boolean hasIptcSegment(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
hasXmpSegment
public boolean hasXmpSegment(ByteSource byteSource) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
getXmpXml
public String getXmpXml(ByteSource byteSource, XmpImagingParameters params) throws ImageReadException, IOException
Extracts embedded XML metadata as XML string.- Specified by:
getXmpXmlin 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, JpegImagingParameters params) throws ImageReadException, IOException
- Throws:
ImageReadExceptionIOException
-
getImageSize
public Dimension getImageSize(ByteSource byteSource, JpegImagingParameters params) throws ImageReadException, IOException
Description copied from class:ImageParserGet the size of the image described by the specified ByteSource.- Specified by:
getImageSizein classImageParser<JpegImagingParameters>- 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, JpegImagingParameters params) throws ImageReadException, IOException
Description copied from class:ImageParserGet 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 classImageParser<JpegImagingParameters>- 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:ImageParserWrite the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter- Overrides:
dumpImageFilein classImageParser<JpegImagingParameters>- 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.
-
-