com.adobe.xmp.path

Class XMPPath

java.lang.Object

com.adobe.xmp.path.XMPPath

All Implemented Interfaces:

Iterable<XMPPathSegment>, Collection<XMPPathSegment>, List<XMPPathSegment>

public class XMPPath
extends Object
implements List<XMPPathSegment>

XMPPath is a Class that provides an easy iterative description of a specific path into the XMP tree. Each XMPPathSegment represents one segment of the path into the XMP tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMPPath.Compare

Constructor Summary

Constructors

Constructor and Description
XMPPath() Creates an empty XMPPath object

Method Summary

Modifier and Type	Method and Description
void	add(int index, XMPPathSegment element)
boolean	add(XMPPathSegment e)
boolean	addAll(Collection<? extends XMPPathSegment> c)
boolean	addAll(int index, Collection<? extends XMPPathSegment> c)
void	clear()
XMPPath.Compare	compare(XMPPath path) Compares the provided path with this path.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object obj)
XMPPathSegment	get(int index)
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<XMPPathSegment>	iterator()
int	lastIndexOf(Object o)
ListIterator<XMPPathSegment>	listIterator()
ListIterator<XMPPathSegment>	listIterator(int index)
static XMPPath	parse(String path, Map<String,String> prefixContract) Creates an XMPPath object by parsing an XMP path String and creates one path segment for each detected segment in the path.
XMPPathSegment	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
String	serialize() Serializes the XMPPath object to a String representation.
String	serialize(Map<String,String> prefixContract) Serializes the XMPPath object to a String representation.
XMPPathSegment	set(int index, XMPPathSegment element)
int	size()
List<XMPPathSegment>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

XMPPath

public XMPPath()

Creates an empty XMPPath object

Method Detail

parse

public static XMPPath parse(String path,
                            Map<String,String> prefixContract)
                     throws XMPPathParserException

Creates an XMPPath object by parsing an XMP path String and creates one path segment for each detected segment in the path.

Parameters:

path - Path string to parse

prefixContract - A Map that contains the mapping between Namespaces and their prefixes. This must be provided to interpret the path correctly. The key must be the prefix and the value the namespace!

Throws:

XMPPathParserException - If the path has an invalid format or a prefix is found that is not defined in the prefixContract

serialize

public String serialize()

Serializes the XMPPath object to a String representation. This will produce a long form of the path using the full namespace strings.

Returns:

String representation of the XMPPath

serialize

public String serialize(Map<String,String> prefixContract)

Serializes the XMPPath object to a String representation. This produces a short form of the path using the prefixes provided by the contract.

Parameters:

prefixContract - A Map that contains the mapping between Namespaces and their prefixes. The key must be the prefix and the value the namespace!

Returns:

String representation of the XMPPath

size

public int size()

Specified by:

size in interface Collection<XMPPathSegment>

Specified by:

size in interface List<XMPPathSegment>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<XMPPathSegment>

Specified by:

isEmpty in interface List<XMPPathSegment>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<XMPPathSegment>

Specified by:

contains in interface List<XMPPathSegment>

iterator

public Iterator<XMPPathSegment> iterator()

Specified by:

iterator in interface Iterable<XMPPathSegment>

Specified by:

iterator in interface Collection<XMPPathSegment>

Specified by:

iterator in interface List<XMPPathSegment>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<XMPPathSegment>

Specified by:

toArray in interface List<XMPPathSegment>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<XMPPathSegment>

Specified by:

toArray in interface List<XMPPathSegment>

add

public boolean add(XMPPathSegment e)

Specified by:

add in interface Collection<XMPPathSegment>

Specified by:

add in interface List<XMPPathSegment>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<XMPPathSegment>

Specified by:

remove in interface List<XMPPathSegment>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<XMPPathSegment>

Specified by:

containsAll in interface List<XMPPathSegment>

addAll

public boolean addAll(Collection<? extends XMPPathSegment> c)

Specified by:

addAll in interface Collection<XMPPathSegment>

Specified by:

addAll in interface List<XMPPathSegment>

addAll

public boolean addAll(int index,
                      Collection<? extends XMPPathSegment> c)

Specified by:

addAll in interface List<XMPPathSegment>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<XMPPathSegment>

Specified by:

removeAll in interface List<XMPPathSegment>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<XMPPathSegment>

Specified by:

retainAll in interface List<XMPPathSegment>

clear

public void clear()

Specified by:

clear in interface Collection<XMPPathSegment>

Specified by:

clear in interface List<XMPPathSegment>

get

public XMPPathSegment get(int index)

Specified by:

get in interface List<XMPPathSegment>

set

public XMPPathSegment set(int index,
                          XMPPathSegment element)

Specified by:

set in interface List<XMPPathSegment>

add

public void add(int index,
                XMPPathSegment element)

Specified by:

add in interface List<XMPPathSegment>

remove

public XMPPathSegment remove(int index)

Specified by:

remove in interface List<XMPPathSegment>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<XMPPathSegment>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<XMPPathSegment>

listIterator

public ListIterator<XMPPathSegment> listIterator()

Specified by:

listIterator in interface List<XMPPathSegment>

listIterator

public ListIterator<XMPPathSegment> listIterator(int index)

Specified by:

listIterator in interface List<XMPPathSegment>

subList

public List<XMPPathSegment> subList(int fromIndex,
                                    int toIndex)

Specified by:

subList in interface List<XMPPathSegment>

compare

public XMPPath.Compare compare(XMPPath path)

Compares the provided path with this path.

Parameters:

path - the path to compare with

Returns:

The paths are equal if both have the same size and each segment is EQUAL. If the provided path is a subpath of this path, ANCESTOR is returned. If the provided path is an ancestor of this path, DESCENDANT is returned. In all other cases the paths are DIFFERENT.

Throws:

IllegalArgumentException - If path is null

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<XMPPathSegment>

Specified by:

hashCode in interface List<XMPPathSegment>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<XMPPathSegment>

Specified by:

equals in interface List<XMPPathSegment>

Overrides:

equals in class Object