Package eu.bandm.tools.paisley.xml

Class XPathPatterns.NodeSet

java.lang.Object

java.util.AbstractCollection<Node>

java.util.AbstractList<Node>

java.util.AbstractSequentialList<Node>

eu.bandm.tools.paisley.xml.XPathPatterns.NodeSet

All Implemented Interfaces:

Iterable<Node>, Collection<Node>, List<Node>, SequencedCollection<Node>

Enclosing class:

XPathPatterns

public static class XPathPatterns.NodeSet
extends AbstractSequentialList<Node>

Lazy list of selected XML nodes.

Objects of this represent what is called node-sets in XPath 1.0. This is an unfortunate and misleading name, since the elements are always ordered, but in various context-dependent ways. It is thus technically and logically more correct to conceive of this class as a kind of list.

Null elements are not supported; a NullPointerException is thrown as early as possible.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method	Description
XPathPatterns.NodeSet	filter(XPathPatterns.Predicate pred)	Returns a node-set that contains only those element of this node-set that are selected by the given predicate, in order.
ListIterator<Node>	listIterator(int index)	Returns a list iterator for this node-set.
static XPathPatterns.NodeSet	of(Iterable<? extends Node> elems)	Returns a new node-set that contains the lazily given elements in order.
static XPathPatterns.NodeSet	of(List<? extends Node> elems)	Returns a new node-set that contains the given elements in order.
static XPathPatterns.NodeSet	of(Node... elems)	Returns a new node-set that contains the given elements in order.
int	size()	Returns the number of elements in this node-set.

Methods inherited from class java.util.AbstractSequentialList

add, addAll, get, iterator, remove, set

Methods inherited from class java.util.AbstractList

add, clear, equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, addFirst, addLast, contains, containsAll, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator, toArray, toArray

Method Details

of

public static XPathPatterns.NodeSet of(Iterable<? extends Node> elems)

Returns a new node-set that contains the lazily given elements in order.

The given elements are computed on demand, by means of an iterator on elems. No data are copied before this method returns. The exact time when each element is demanded is unpredictable. Hence the iteration should be invariant over time; otherwise behavior is unspecified.

If lazy iteration produces a null element later during access to the constructed node-set, NullPointerException is thrown. In that case, the node-set should be considered invalidated and not accessed again.

Parameters:

elems - an object capable of producing elements by iteration

Returns:

a new node-set that contains elems in order

Throws:

NullPointerException - if elems is null

of

public static XPathPatterns.NodeSet of(Node... elems)

Returns a new node-set that contains the given elements in order.

The given array is copied before this method returns. Subsequent changes to the array have no effect on the returned node-set.

Parameters:

elems - an array of elements

Returns:

a new node-set that contains elems in order

Throws:

NullPointerException - if elems is or contains null

of

public static XPathPatterns.NodeSet of(List<? extends Node> elems)

Returns a new node-set that contains the given elements in order.

The given list is copied before this method returns. Subsequent changes to the list have no effect on the returned node-set.

Parameters:

elems - a list of elements

Returns:

a new node-set that contains elems in order

Throws:

NullPointerException - if elems is or contains null

size

public int size()

Returns the number of elements in this node-set.

If this list is being populated lazily, a call to this method enforces completion.

Specified by:

size in interface Collection<Node>

Specified by:

size in interface List<Node>

Specified by:

size in class AbstractCollection<Node>

listIterator

public ListIterator<Node> listIterator(int index)

Returns a list iterator for this node-set.

Node-sets are immutable; the returned iterator does not support the operations add, set and remove.

The access operations next and previous do not tolerate null elements. If a null element is produced lazily on demand from such an access operation, a NullPointerException is thrown.

Specified by:

listIterator in interface List<Node>

Specified by:

listIterator in class AbstractSequentialList<Node>

Parameters:

index - the first element to be returned from the list iterator (by a call to next)

Returns:

an unmodifiable list iterator over the elements of this node-set, in order

filter

public XPathPatterns.NodeSet filter(XPathPatterns.Predicate pred)

Returns a node-set that contains only those element of this node-set that are selected by the given predicate, in order.

The resulting node-set is computed lazily on demand.

Parameters:

pred - the predicate to filter this node-set with

Returns:

a node-set that contains only those element of this node-set that are selected by pred

Throws:

NullPointerException - if pred is null