Package org.apache.commons.imaging.common

Interface XmpEmbeddable<E extends XmpImagingParameters<E>>

Type Parameters:

E - The type of XmpImagingParameters.

All Known Implementing Classes:

GifImageParser, JpegImageParser, PngImageParser, PsdImageParser, TiffImageParser, WebPImageParser

public interface XmpEmbeddable<E extends XmpImagingParameters<E>>

Implementations support embedding the Extensible Metadata Platform tags.

See Also:

https://en.wikipedia.org/wiki/Extensible_Metadata_Platform

Method Summary

Modifier and Type	Method	Description
java.lang.String	getXmpXml(ByteSource byteSource, XmpImagingParameters<E> params)	Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content.

Method Detail

getXmpXml

java.lang.String getXmpXml(ByteSource byteSource,
                           XmpImagingParameters<E> params)
                    throws ImagingException,
                           java.io.IOException

Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content. Not all image formats support XMP information and even for those that do, there is no guarantee that such information will be present in an image.

Parameters:

byteSource - A valid reference to a ByteSource.

params - Optional instructions for special-handling or interpretation of the input data.

Returns:

If XMP metadata is present, a valid string; if it is not present, a null.

Throws:

ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.

java.io.IOException - In the event of unsuccessful read or access operation.