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; 020 021import org.apache.commons.imaging.ImagingException; 022import org.apache.commons.imaging.bytesource.ByteSource; 023 024/** 025 * Implementations support embedding the Extensible Metadata Platform tags. 026 * 027 * @param <E> The type of {@link XmpImagingParameters}. 028 * @see <a href="https://en.wikipedia.org/wiki/Extensible_Metadata_Platform">https://en.wikipedia.org/wiki/Extensible_Metadata_Platform</a> 029 */ 030public interface XmpEmbeddable<E extends XmpImagingParameters<E>> { 031 032 /** 033 * Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content. Not all 034 * image formats support XMP information and even for those that do, there is no guarantee that such information will be present in an image. 035 * 036 * @param byteSource A valid reference to a ByteSource. 037 * @param params Optional instructions for special-handling or interpretation of the input data. 038 * @return If XMP metadata is present, a valid string; if it is not present, a null. 039 * @throws ImagingException In the event that the specified content does not conform to the format of the specific parser implementation. 040 * @throws IOException In the event of unsuccessful read or access operation. 041 */ 042 String getXmpXml(ByteSource byteSource, XmpImagingParameters<E> params) throws ImagingException, IOException; 043 044}