Package com.adobe.xmp.core

Interface XMPSimple

All Superinterfaces:

java.lang.Iterable<XMPNode>, XMPNode

public interface XMPSimple
extends XMPNode

A simple property represents a key/value pair and can be seen as a leaf of the tree (if not qualified).

Method Summary

Modifier and Type	Method	Description
java.lang.String	dump()	returns a human readable version of this node tree (recursive)
XMPNode	get(XMPPath path)	Return the node of the given path, relative to this node.
XMPArray	getArray(XMPPath path)	Returns an array from the given path, relative to this node.
XMPLanguageAlternative	getLanguageAlternative(XMPPath path)	Returns a language Alternative from the given path, relative to this node.
XMPSimple	getSimple(XMPPath path)	Returns a simple property from the given path, relative to this node.
XMPStruct	getStruct(XMPPath path)	Returns a struct property from the given path, relative to this node.
java.lang.String	getValue()	Returns the value of this property
XMPPath	getXMPPath()	Return the path of this XMPNode
boolean	isURI()
XMPNode	remove(XMPPath path)	Remove a node at a given path, relative to this node
void	setURI(boolean isURI)	Set URI type.
void	setValue(java.lang.String value)	Set the value of this property

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.adobe.xmp.core.XMPNode

accept, accessQualifiers, adaptTo, copyReplace, getName, getNamespace, getParent, hasQualifiers, isArrayItem, iterator, size

Method Detail

getValue

java.lang.String getValue()

Returns the value of this property

Returns:

the value of this property

setValue

void setValue(java.lang.String value)

Set the value of this property

Parameters:

value - Value of simple property to set

isURI

boolean isURI()

Returns:

Returns whether is property is of type URI.

setURI

void setURI(boolean isURI)

Set URI type.

Parameters:

isURI - Property is of type URI or not

getXMPPath

XMPPath getXMPPath()

Return the path of this XMPNode

Returns:

the path of this XMPNode

get

XMPNode get(XMPPath path)

Return the node of the given path, relative to this node.

Parameters:

path - the path to the desired node relative to this node

Returns:

the node at the path position or null if it could not be found

remove

XMPNode remove(XMPPath path)
        throws XMPException

Remove a node at a given path, relative to this node

Parameters:

path - the path to the node that shall be deleted

Returns:

the removed node or null, if nothing is removed

Throws:

XMPException - throws in case the remove path points to an xml:lang qualifier of a Language Alternative

getSimple

XMPSimple getSimple(XMPPath path)

Returns a simple property from the given path, relative to this node.

Parameters:

path - the path to the simple property, relative to this node.

Returns:

the desired simple property or null if there was none (or the type is different)

getStruct

XMPStruct getStruct(XMPPath path)

Returns a struct property from the given path, relative to this node.

Parameters:

path - the path to the struct property, relative to this node.

Returns:

the desired struct property or null if there was none (or the type is different)

getArray

XMPArray getArray(XMPPath path)

Returns an array from the given path, relative to this node.

Parameters:

path - the path to the array, relative to this node.

Returns:

the desired array or null if there was none (or the type is different)

getLanguageAlternative

XMPLanguageAlternative getLanguageAlternative(XMPPath path)

Returns a language Alternative from the given path, relative to this node.

Parameters:

path - the path to the langAlt, relative to this node.

Returns:

the desired langAlt or null if there was none (or the type is different)

dump

java.lang.String dump()

returns a human readable version of this node tree (recursive)

Returns:

returns a human readable version of this node tree (recursive)