1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.imaging.common;
18
19 import java.io.IOException;
20
21 import org.apache.commons.imaging.ImagingException;
22 import org.apache.commons.imaging.bytesource.ByteSource;
23
24 /**
25 * Implementations support embedding the Extensible Metadata Platform tags.
26 *
27 * @param <E> The type of {@link XmpImagingParameters}.
28 * @see <a href="https://en.wikipedia.org/wiki/Extensible_Metadata_Platform">https://en.wikipedia.org/wiki/Extensible_Metadata_Platform</a>
29 */
30 public interface XmpEmbeddable<E extends XmpImagingParameters<E>> {
31
32 /**
33 * Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content. Not all
34 * image formats support XMP information and even for those that do, there is no guarantee that such information will be present in an image.
35 *
36 * @param byteSource A valid reference to a ByteSource.
37 * @param params Optional instructions for special-handling or interpretation of the input data.
38 * @return If XMP metadata is present, a valid string; if it is not present, a null.
39 * @throws ImagingException In the event that the specified content does not conform to the format of the specific parser implementation.
40 * @throws IOException In the event of unsuccessful read or access operation.
41 */
42 String getXmpXml(ByteSource byteSource, XmpImagingParameters<E> params) throws ImagingException, IOException;
43
44 }