com.groupdocs.metadata.core

Class XmpPackage

java.lang.Object

com.groupdocs.metadata.core.MetadataPackage

com.groupdocs.metadata.core.CustomPackage

com.groupdocs.metadata.core.XmpMetadataContainer

com.groupdocs.metadata.core.XmpPackage

All Implemented Interfaces:

IXmpType, Iterable<MetadataProperty>

Direct Known Subclasses:

XmpBasicJobTicketPackage, XmpBasicPackage, XmpCameraRawPackage, XmpDublinCorePackage, XmpDynamicMediaPackage, XmpIptcCorePackage, XmpIptcExtensionPackage, XmpIptcIimPackage, XmpMediaManagementPackage, XmpPagedTextPackage, XmpPdfPackage, XmpPhotoshopPackage, XmpRightsManagementPackage

public class XmpPackage
extends XmpMetadataContainer

Represents base abstraction for XMP package.

Learn more

• Working with XMP metadata

This example demonstrates how to add a custom XMP package to a file of any supported format.

 try (Metadata metadata = new Metadata(Constants.InputJpeg)) {
     IXmp root = (IXmp) metadata.getRootPackage();
     XmpPacketWrapper packet = new XmpPacketWrapper();
     XmpPackage custom = new XmpPackage("gd", "https://groupdocs.com");
     custom.set("gd:Copyright", "Copyright (C) 2011-2024 GroupDocs. All Rights Reserved.");
     custom.set("gd:CreationDate", new Date());
     custom.set("gd:Company", XmpArray.from(new String[]{"Aspose", "GroupDocs"}, XmpArrayType.Ordered));
     packet.addPackage(custom);
     root.setXmpPackage(packet);
     metadata.save(Constants.OutputJpeg);
 }
 

Constructor Summary

Constructors

Constructor and Description
XmpPackage(String prefix, String namespaceUri) Initializes a new instance of the XmpPackage class.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all XMP properties.
String	getNamespaceUri() Gets the namespace URI.
String	getPrefix() Gets the xmlns prefix.
String	getXmlNamespace() Gets the XML namespace.
String	getXmpRepresentation() Converts the XMP value to the XML representation.
boolean	remove(String name) Removes the property with the specified name.
void	set(String name, boolean value) Sets boolean property.
void	set(String name, Date value) Sets DateTime property.
void	set(String name, double value) Sets double property.
void	set(String name, int value) Sets integer property.
void	set(String name, String value) Sets string property.
void	set(String name, XmpArray value) Sets the value inherited from XmpArray .
void	set(String name, XmpComplexType value) Sets the value inherited from XmpComplexType .
void	set(String name, XmpValueBase value) Sets the value inherited from XmpValueBase .

Methods inherited from class com.groupdocs.metadata.core.MetadataPackage

addProperties, contains, findProperties, get_Item, getCount, getKeys, getKnowPropertyDescriptors, getMetadataType, getPropertyDescriptors, iterator, removeProperties, sanitize, setProperties, updateProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XmpPackage

public XmpPackage(String prefix,
                  String namespaceUri)

Initializes a new instance of the XmpPackage class.

Parameters:

prefix - XMP prefix, for example dc:title.

namespaceUri - Namespace uri.

Method Detail

clear

public final void clear()

Removes all XMP properties.

getNamespaceUri

public final String getNamespaceUri()

Gets the namespace URI.

Returns:

The namespace URI.

getPrefix

public final String getPrefix()

Gets the xmlns prefix.

Returns:

The prefix.

getXmlNamespace

public final String getXmlNamespace()

Gets the XML namespace.

Returns:

The XML namespace.

getXmpRepresentation

public String getXmpRepresentation()

Converts the XMP value to the XML representation.

Specified by:

getXmpRepresentation in interface IXmpType

Specified by:

getXmpRepresentation in class XmpMetadataContainer

Returns:

A string representation of the XMP value.

remove

public final boolean remove(String name)

Removes the property with the specified name.

Parameters:

name - XMP metadata property name.

Returns:

True if the specified metadata property is found and removed; otherwise, false.

set

public final void set(String name,
                      boolean value)

Sets boolean property.

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public final void set(String name,
                      Date value)

Sets DateTime property.

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public final void set(String name,
                      double value)

Sets double property.

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public final void set(String name,
                      int value)

Sets integer property.

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public void set(String name,
                String value)

Sets string property.

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public void set(String name,
                XmpArray value)

Sets the value inherited from XmpArray .

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public void set(String name,
                XmpComplexType value)

Sets the value inherited from XmpComplexType .

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.

set

public final void set(String name,
                      XmpValueBase value)

Sets the value inherited from XmpValueBase .

Parameters:

name - XMP metadata property name.

value - XMP metadata property value.