XmpMetadata (Aspose.Page for Java (25.11) API Documentation)

java.lang.Object
- com.aspose.eps.xmp.XmpMetadata

All Implemented Interfaces:

Map<String,XmpValue>
```
public final class XmpMetadata
extends Object
implements Map<String,XmpValue>
```
Class for manipulation with XMP metadata.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addArrayItem(String arrayKey, int index, XmpValue value)` Adds value into an array by specified index.
`void`	`addArrayItem(String arrayKey, XmpValue value)` Adds value into an array.
`void`	`addItem(Map.Entry<String,XmpValue> item)` Adds pair with key and value into the dictionary.
`void`	`addNamedValue(String structureKey, String valueKey, XmpValue value)` Adds named value into a structure.
`void`	`clear()` Removes all elements from the object.
`boolean`	`containsKey(Object key)` Checks if dictionary contains the specified key.
`boolean`	`containsKey(String key)` Determines does this dictionary contasins specified key.
`boolean`	`containsValue(Object value)` Returns `true` if this map maps one or more keys to the specified value.
`void`	`copyToArray(Map.Entry<String,XmpValue>[] array, int index)` Copy metadata into array.
`Set<Map.Entry<String,XmpValue>>`	`entrySet()` Gets enumerator object of the dictionary.
`XmpValue`	`get(Object key)` Gets value by key.
`String`	`getNamespaceURIByPrefix(String prefix)` Gets namespace URI by prefix.
`String`	`getPrefixByNamespaceURI(String namespaceURI)` Gets the prefix by namespace URI.
`Object`	`getSyncRoot()` Gets synchroniztion object of the collection.
`boolean`	`isEmpty()` Returns `true` if this set contains no elements.
`Set<String>`	`keySet()` Gets keys from the dictionary.
`XmpValue`	`put(String key, XmpValue value)` Adds new element to the dictionary object.
`void`	`putAll(Map<? extends String,? extends XmpValue> m)` Copies all of the mappings from the specified map to this map (optional operation).
`void`	`registerNamespaceURI(String prefix, String namespaceURI)` Registers the namespace URI.
`XmpValue`	`remove(Map.Entry<String,XmpValue> item)` Removes key/value pair from the colleciton.
`XmpValue`	`remove(Object key)` Removes key from the dictionary.
`void`	`setArrayItem(String arrayKey, int index, XmpValue value)` Sets value in an array.
`void`	`setNamedValue(String structureKey, String valueKey, XmpValue value)` Sets named value into a structure.
`int`	`size()` Gets count if items in the collection.
`boolean`	`tryGetValue(String key, Object[] value)` Tries to find key in the dictionary and retreives value if found.
`Collection<XmpValue>`	`values()` Gets the collection of values in dictionary.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

- Method Detail
  - registerNamespaceURI
```
public void registerNamespaceURI(String prefix,
                                 String namespaceURI)
```
    Registers the namespace URI.
```
 XmpMetadata xmp = new XmpMetadata("input.pdf");
 xmp.registerNamespaceURI("xmp", "http://ns.adobe.com/xap/1.0/");
 
```
    Parameters:
    
    prefix - The prefix.
    
    namespaceURI - The namespace URI.
  - getNamespaceURIByPrefix
```
public String getNamespaceURIByPrefix(String prefix)
```
    Gets namespace URI by prefix.
```
 XmpMetadata xmp = new XmpMetadata("input.pdf");
 System.out.println(xmp.getNamespaceURIByPrefix("xmp"));
 
```
    Parameters:
    
    prefix - The prefix.
    
    Returns:
    
    Namespace URI.
  - getPrefixByNamespaceURI
```
public String getPrefixByNamespaceURI(String namespaceURI)
```
    Gets the prefix by namespace URI.
```
 XmpMetadata xmp = new XmpMetadata("input.pdf");
 System.out.println(xmp.getPrefixByNamespaceURI("http://ns.adobe.com/xap/1.0/"));
 
```
    Parameters:
    
    namespaceURI - Namespace URI.
    
    Returns:
    
    The prefix value.
  - clear
```
public void clear()
```
    Removes all elements from the object.
```
 XmpMetadata xmp = new XmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.clear();
 
```
    Specified by:
    
    clear in interface Map<String,XmpValue>
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this set contains no elements.
    
    Specified by:
    
    isEmpty in interface Map<String,XmpValue>
    
    Returns:
    
    true if this set contains no elements
  - put
```
public XmpValue put(String key,
                    XmpValue value)
```
    Adds new element to the dictionary object.
    
    Specified by:
    
    put in interface Map<String,XmpValue>
    
    Parameters:
    
    key - Key of new element.
    
    value - Value of the element.
  - putAll
```
public void putAll(Map<? extends String,? extends XmpValue> m)
```
    Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
    
    Specified by:
    
    putAll in interface Map<String,XmpValue>
    
    Parameters:
    
    m - mappings to be stored in this map
    
    Throws:
    
    UnsupportedOperationException - if the putAll operation is not supported by this map
    
    ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map
    
    NullPointerException - if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values
    
    IllegalArgumentException - if some property of a key or value in the specified map prevents it from being stored in this map
  - containsKey
```
public boolean containsKey(Object key)
```
    Checks if dictionary contains the specified key.
```
 XmpMetadata xmp = new XmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.add("xmp:Nickname", "Nickname1");
 if (!xmp.contains("xmp:Nickname"))
   System.out.println("Key does not exists");
 
```
    Specified by:
    
    containsKey in interface Map<String,XmpValue>
    
    Parameters:
    
    key - Key which will be checked.
    
    Returns:
    
    True - if the dictionary contains the specified key; otherwise, false.
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.
    
    Specified by:
    
    containsValue in interface Map<String,XmpValue>
    
    Parameters:
    
    value - value whose presence in this map is to be tested
    
    Returns:
    
    true if this map maps one or more keys to the specified value
    
    Throws:
    
    ClassCastException - if the value is of an inappropriate type for this map (optional)
    
    NullPointerException - if the specified value is null and this map does not permit null values (optional)
  - entrySet
```
public Set<Map.Entry<String,XmpValue>> entrySet()
```
    Gets enumerator object of the dictionary.
    
    Specified by:
    
    entrySet in interface Map<String,XmpValue>
    
    Returns:
    
    The enumerator object.
  - keySet
```
public Set<String> keySet()
```
    Gets keys from the dictionary.
    
    Specified by:
    
    keySet in interface Map<String,XmpValue>
    
    Returns:
    
    ICollection element
  - remove
```
public XmpValue remove(Object key)
```
    Removes key from the dictionary.
```
 XmpMetadata xmp = new XmpMetadata();
 xmp.bindPdf("input.pdf");
 xmp.remove("xmp:Nickname");
 
```
    Specified by:
    
    remove in interface Map<String,XmpValue>
    
    Parameters:
    
    key - Key which will be removed.
  - values
```
public Collection<XmpValue> values()
```
    Gets the collection of values in dictionary.
    
    Specified by:
    
    values in interface Map<String,XmpValue>
    
    Returns:
    
    ICollection object
  - get
```
public XmpValue get(Object key)
```
    Gets value by key.
```
 XmpMetadata pxm = new XmpMetadata();
 pxm.bindPdf("PdfFile.pdf");
 System.out.println(pxm.get_Item("xmp:Nickname"));
 
```
    Specified by:
    
    get in interface Map<String,XmpValue>
    
    Parameters:
    
    key - The key name to get.
    
    Returns:
    
    Object by key
  - copyToArray
```
public void copyToArray(Map.Entry<String,XmpValue>[] array,
                        int index)
```
    Copy metadata into array.
    
    Parameters:
    
    array - The destination array.
    
    index - The starting index.
  - size
```
public int size()
```
    Gets count if items in the collection.
    Specified by:
    
    size in interface Map<String,XmpValue>
    
    Returns:
    int value
    
    XmpMetadata pxm = new XmpMetadata(); pxm.bindPdf("PdfFile.pdf"); System.out.println("Count = " + pxm.size());
  - getSyncRoot
```
public Object getSyncRoot()
```
    Gets synchroniztion object of the collection.
    
    Returns:
    
    Object element
  - containsKey
```
public boolean containsKey(String key)
```
    Determines does this dictionary contasins specified key.
    
    Parameters:
    
    key - Key to search in the dictionary.
    
    Returns:
    
    true if key is found.
  - tryGetValue
```
public boolean tryGetValue(String key,
                           Object[] value)
```
    Tries to find key in the dictionary and retreives value if found.
    
    Parameters:
    
    key - Key to search in the dictionary.
    
    value - Retreived value.
    
    Returns:
    
    true if key was found.
  - addItem
```
public void addItem(Map.Entry<String,XmpValue> item)
```
    Adds pair with key and value into the dictionary.
    
    Parameters:
    
    item - Item to be added.
  - addArrayItem
```
public void addArrayItem(String arrayKey,
                         XmpValue value)
```
    Adds value into an array. The value will be added at the end of the array.
    
    Parameters:
    
    arrayKey - Key of the array to search in the dictionary.
    
    value - Value to add into the array.
  - addArrayItem
```
public void addArrayItem(String arrayKey,
                         int index,
                         XmpValue value)
```
    Adds value into an array by specified index.
    
    Parameters:
    
    arrayKey - Key of the array to search in the dictionary.
    
    index - Index of new value in the array.
    
    value - Value to add into the array.
  - setArrayItem
```
public void setArrayItem(String arrayKey,
                         int index,
                         XmpValue value)
```
    Sets value in an array. Previous value will be replaced with new one.
    
    Parameters:
    
    arrayKey - Key of the array to search in the dictionary.
    
    index - Index of new value in the array.
    
    value - Value to set in the array.
  - addNamedValue
```
public void addNamedValue(String structureKey,
                          String valueKey,
                          XmpValue value)
```
    Adds named value into a structure.
    
    Parameters:
    
    structureKey - Key of the structure to search in the dictionary.
    
    valueKey - Name of the value to add into the structure.
    
    value - Value to add into the structure.
  - setNamedValue
```
public void setNamedValue(String structureKey,
                          String valueKey,
                          XmpValue value)
```
    Sets named value into a structure. Previous named value, if already exists, will be replaced with new one.
    
    Parameters:
    
    structureKey - Key of the structure to search in the dictionary.
    
    valueKey - Name of the value to add into the structure.
    
    value - Value to set into the structure.
  - remove
```
public XmpValue remove(Map.Entry<String,XmpValue> item)
```
    Removes key/value pair from the colleciton.
    
    Parameters:
    
    item - Key/value pair to be removed.
    
    Returns:
    
    true if pair was found and removed.

Class XmpMetadata

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Method Detail

registerNamespaceURI

getNamespaceURIByPrefix

getPrefixByNamespaceURI

clear

isEmpty

put

putAll

containsKey

containsValue

entrySet

keySet

remove

values

get

copyToArray

size

getSyncRoot

containsKey

tryGetValue

addItem

addArrayItem

addArrayItem

setArrayItem

addNamedValue

setNamedValue

remove