org.apache.commons.imaging.common

## Interface XmpEmbeddable

- All Known Implementing Classes:
    GifImageParser, JpegImageParser, PngImageParser, PsdImageParser, TiffImageParser

      public interface XmpEmbeddable

  Implementations support embedding the Extensible Metadata Platform tags.
  Since:
    1.0
  See Also:
    https://en.wikipedia.org/wiki/Extensible_Metadata_Platform

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getXmpXml(ByteSource byteSource, Map<String,Object> params)` Get a string containing XML-formatted text conforming to the Extensible Metadata Platform (EXP) standard for representing information about image content.

- - ### Method Detail

    - #### getXmpXml

          String getXmpXml(ByteSource byteSource,
                           Map<String,Object> params)
                    throws ImageReadException,
                           IOException

      Get a string containing XML-formatted text conforming to the Extensible Metadata Platform (EXP) standard for representing information about image content. Not all image formats support EXP 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:
        `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.

Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.