Class IptcParser

java.lang.Object

org.apache.commons.imaging.common.BinaryFileParser

org.apache.commons.imaging.formats.jpeg.iptc.IptcParser

public class IptcParser
extends BinaryFileParser

Field Summary

Fields

Modifier and Type	Field	Description
private static final ByteOrder	APP13_BYTE_ORDER
private static final byte[]	CHARACTER_ESCAPE_SEQUENCE
private static final Charset	DEFAULT_CHARSET
private static final int	ENV_TAG_CODED_CHARACTER_SET
private static final Logger	LOGGER
private static final List<Integer>	PHOTOSHOP_IGNORED_BLOCK_TYPE	Block types (or Image Resource IDs) that are not recommended to be interpreted when libraries process Photoshop IPTC metadata.

Constructor Summary

Constructors

Constructor	Description
IptcParser()	Constructs a new instance with the default, big-endian, byte order.

Method Summary

Modifier and Type	Method	Description
private Charset	findCharset(byte[] codedCharset)
boolean	isPhotoshopJpegSegment(byte[] segmentData)
protected List<IptcBlock>	parseAllBlocks(byte[] bytes, boolean strict)
protected List<IptcRecord>	parseIptcBlock(byte[] bytes)
PhotoshopApp13Data	parsePhotoshopSegment(byte[] bytes, boolean strict)
PhotoshopApp13Data	parsePhotoshopSegment(byte[] bytes, ImagingParameters<JpegImagingParameters> params)
byte[]	writeIptcBlock(List<IptcRecord> elements)
byte[]	writeIptcBlock(List<IptcRecord> elements, boolean forceUtf8Encoding)
byte[]	writePhotoshopApp13Segment(PhotoshopApp13Data data)

Methods inherited from class BinaryFileParser

debugNumber, debugNumber, getByteOrder, setByteOrder

Methods inherited from class Object

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

Field Details

LOGGER

private static final Logger LOGGER

APP13_BYTE_ORDER

private static final ByteOrder APP13_BYTE_ORDER

PHOTOSHOP_IGNORED_BLOCK_TYPE

private static final List<Integer> PHOTOSHOP_IGNORED_BLOCK_TYPE

Block types (or Image Resource IDs) that are not recommended to be interpreted when libraries process Photoshop IPTC metadata.

Since:

1.0-alpha2

See Also:

• Adobe Photoshop File Formats Specification
• IMAGING-246

DEFAULT_CHARSET

private static final Charset DEFAULT_CHARSET

ENV_TAG_CODED_CHARACTER_SET

private static final int ENV_TAG_CODED_CHARACTER_SET

See Also:

• Constant Field Values

CHARACTER_ESCAPE_SEQUENCE

private static final byte[] CHARACTER_ESCAPE_SEQUENCE

Constructor Details

IptcParser

public IptcParser()

Constructs a new instance with the default, big-endian, byte order.

Method Details

findCharset

private Charset findCharset(byte[] codedCharset)

isPhotoshopJpegSegment

public boolean isPhotoshopJpegSegment(byte[] segmentData)

parseAllBlocks

protected List<IptcBlock> parseAllBlocks(byte[] bytes,
 boolean strict)
                                  throws ImagingException,
IOException

Throws:

ImagingException

IOException

parseIptcBlock

protected List<IptcRecord> parseIptcBlock(byte[] bytes)

parsePhotoshopSegment

public PhotoshopApp13Data parsePhotoshopSegment(byte[] bytes,
 boolean strict)
                                         throws ImagingException,
IOException

Throws:

ImagingException

IOException

parsePhotoshopSegment

public PhotoshopApp13Data parsePhotoshopSegment(byte[] bytes,
 ImagingParameters<JpegImagingParameters> params)
                                         throws ImagingException,
IOException

Throws:

ImagingException

IOException

writeIptcBlock

public byte[] writeIptcBlock(List<IptcRecord> elements)
                      throws ImagingException,
IOException

Throws:

ImagingException

IOException

writeIptcBlock

public byte[] writeIptcBlock(List<IptcRecord> elements,
 boolean forceUtf8Encoding)
                      throws ImagingException,
IOException

Throws:

ImagingException

IOException

writePhotoshopApp13Segment

public byte[] writePhotoshopApp13Segment(PhotoshopApp13Data data)
                                  throws IOException,
ImagingException

Throws:

IOException

ImagingException