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