Package org.apache.commons.imaging.formats.jpeg

Class JpegImageParser

java.lang.Object

org.apache.commons.imaging.common.BinaryFileParser

org.apache.commons.imaging.AbstractImageParser<JpegImagingParameters>

org.apache.commons.imaging.formats.jpeg.JpegImageParser

All Implemented Interfaces:

XmpEmbeddable<JpegImagingParameters>

public class JpegImageParser
extends AbstractImageParser<JpegImagingParameters>
implements XmpEmbeddable<JpegImagingParameters>

Constructor Summary

Constructors

Constructor	Description
JpegImageParser()

Method Summary

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 PrintWriter
protected String[]	getAcceptedExtensions()	Gets an array of all accepted extensions
protected ImageFormat[]	getAcceptedTypes()	Gets an array of ImageFormat objects describing all accepted types
final BufferedImage	getBufferedImage(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).
String	getDefaultExtension()	Gets the default extension for the format specified by an implementation of ImageParser.
JpegImagingParameters	getDefaultParameters()	Gets a default parameters instance for this parser.
TiffImageMetadata	getExifMetadata(ByteSource byteSource, TiffImagingParameters params)
byte[]	getExifRawData(ByteSource byteSource)
byte[]	getIccProfileBytes(ByteSource byteSource, JpegImagingParameters 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.
ImageInfo	getImageInfo(ByteSource byteSource, JpegImagingParameters params)	Gets image information from the specified ByteSource.
Dimension	getImageSize(ByteSource byteSource, JpegImagingParameters params)	Gets the size of the image described by the specified ByteSource.
ImageMetadata	getMetadata(ByteSource byteSource, JpegImagingParameters params)	Gets image metadata from the specified byte source.
String	getName()	Gets a descriptive name for the implementation of an ImageParser.
JpegPhotoshopMetadata	getPhotoshopMetadata(ByteSource byteSource, JpegImagingParameters params)
String	getXmpXml(ByteSource byteSource, XmpImagingParameters<JpegImagingParameters> 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<AbstractSegment>	readSegments(ByteSource byteSource, int[] markers, boolean returnAfterFirst)

Methods inherited from class org.apache.commons.imaging.AbstractImageParser

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JpegImageParser

public JpegImageParser()

Method Details

isExifApp1Segment

public static boolean isExifApp1Segment(GenericSegment segment)

dumpImageFile

public boolean dumpImageFile(PrintWriter pw,
 ByteSource byteSource)
                      throws ImagingException,
IOException

Description copied from class: AbstractImageParser

Write the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter

Overrides:

dumpImageFile in class AbstractImageParser<JpegImagingParameters>

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<JpegImagingParameters>

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<JpegImagingParameters>

Returns:

A valid array of one or more elements.

getBufferedImage

public final BufferedImage getBufferedImage(ByteSource byteSource,
 JpegImagingParameters 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<JpegImagingParameters>

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<JpegImagingParameters>

Returns:

A valid string.

getDefaultParameters

public JpegImagingParameters getDefaultParameters()

Description copied from class: AbstractImageParser

Gets a default parameters instance for this parser.

Specified by:

getDefaultParameters in class AbstractImageParser<JpegImagingParameters>

Returns:

default parameters instance

getExifMetadata

public TiffImageMetadata getExifMetadata(ByteSource byteSource,
 TiffImagingParameters params)
                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException

getExifRawData

public byte[] getExifRawData(ByteSource byteSource)
                      throws ImagingException,
IOException

Throws:

ImagingException

IOException

getIccProfileBytes

public byte[] getIccProfileBytes(ByteSource byteSource,
 JpegImagingParameters 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<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:

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,
 JpegImagingParameters 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<JpegImagingParameters>

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,
 JpegImagingParameters 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<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:

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,
 JpegImagingParameters 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<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:

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<JpegImagingParameters>

Returns:

a valid, subject-matter-specific string.

getPhotoshopMetadata

public JpegPhotoshopMetadata getPhotoshopMetadata(ByteSource byteSource,
 JpegImagingParameters params)
                                           throws ImagingException,
IOException

Throws:

ImagingException

IOException

getXmpXml

public String getXmpXml(ByteSource byteSource,
 XmpImagingParameters<JpegImagingParameters> params)
                 throws ImagingException,
IOException

Extracts embedded XML metadata as XML string.

Specified by:

getXmpXml in interface XmpEmbeddable<JpegImagingParameters>

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.

hasExifSegment

public boolean hasExifSegment(ByteSource byteSource)
                       throws ImagingException,
IOException

Throws:

ImagingException

IOException

hasIptcSegment

public boolean hasIptcSegment(ByteSource byteSource)
                       throws ImagingException,
IOException

Throws:

ImagingException

IOException

hasXmpSegment

public boolean hasXmpSegment(ByteSource byteSource)
                      throws ImagingException,
IOException

Throws:

ImagingException

IOException

readSegments

public List<AbstractSegment> readSegments(ByteSource byteSource,
 int[] markers,
 boolean returnAfterFirst)
                                   throws ImagingException,
IOException

Throws:

ImagingException

IOException