    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.imaging.common;
    018
    019import java.io.IOException;
    020import java.util.Map;
    021
    022import org.apache.commons.imaging.ImageReadException;
    023import org.apache.commons.imaging.common.bytesource.ByteSource;
    024
    025/**
    026 * Implementations support embedding the Extensible Metadata Platform
    027 * tags.
    028 *
    029 * @see <a href="https://en.wikipedia.org/wiki/Extensible_Metadata_Platform">https://en.wikipedia.org/wiki/Extensible_Metadata_Platform</a>
    030 * @since 1.0
    031 */
    032public interface XmpEmbeddable {
    033
    034    /**
    035     * Get a string containing XML-formatted text conforming to the Extensible
    036     * Metadata  Platform (EXP) standard for representing information about
    037     * image content.  Not all image formats support EXP information and
    038     * even for those that do, there is no guarantee that such information
    039     * will be present in an image.
    040     *
    041     * @param byteSource A valid reference to a ByteSource.
    042     * @param params     Optional instructions for special-handling or
    043     *                   interpretation of the input data.
    044     * @return If XMP metadata is present, a valid string;
    045     *         if it is not present, a null.
    046     * @throws ImageReadException In the event that the specified content
    047     *                            does not conform to the format of the specific
    048     *                            parser implementation.
    049     * @throws IOException        In the event of unsuccessful read or access operation.
    050     */
    051    String getXmpXml(ByteSource byteSource, Map<String, Object> params)
    052            throws ImageReadException, IOException;
    053
    054}