com.tailf.jnc

Class NodeSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Element>

com.tailf.jnc.NodeSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Element>, java.util.Collection<Element>, java.util.List<Element>, java.util.RandomAccess

public class NodeSet
extends java.util.ArrayList<Element>

A set of Element nodes.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
NodeSet() Construct a new empty NodeSet
NodeSet(Element node) Construct a new NodeSet which contains the given element.

Method Summary

Modifier and Type	Method and Description
Element	findMember(Element x) Searches for an element in this NodeSet.
Element	first()
NodeSet	get(java.lang.String pathStr) 'Get' using path expression on nodes within the set.
Element	getElement(int index) Gets an element from the node set.
Element	getFirst(java.lang.String pathStr) 'Get' using path expression on nodes within the set.
boolean	isMember(Element x) Checks if an element is a member of the NodeSet.
Element	last()
boolean	removeMember(Element x) Removes a member element from the NodeSet.
java.lang.String	toXMLString() Formats the NodeSet in XML format.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

NodeSet

public NodeSet(Element node)

Construct a new NodeSet which contains the given element.

NodeSet

public NodeSet()

Construct a new empty NodeSet

Method Detail

getElement

public Element getElement(int index)

Gets an element from the node set.

get

public NodeSet get(java.lang.String pathStr)
            throws JNCException

'Get' using path expression on nodes within the set. returning new NodeSet

Parameters:

pathStr - Path string to find nodes within the nodes

Throws:

JNCException

getFirst

public Element getFirst(java.lang.String pathStr)
                 throws JNCException

'Get' using path expression on nodes within the set. returning the first Element that matches

Parameters:

pathStr - Path string to find an element within the nodes

Throws:

JNCException

first

public Element first()

Returns:

first element from this node set, or null if none.

last

public Element last()

Returns:

last element from this node set, or null if none.

isMember

public boolean isMember(Element x)

Checks if an element is a member of the NodeSet. Elements are compared with the Element.equals method.

Parameters:

x - Element to check for

findMember

public Element findMember(Element x)

Searches for an element in this NodeSet. Elements are compared with the Element.equals method.

Parameters:

x - Element to find

Returns:

the found member or null

removeMember

public boolean removeMember(Element x)

Removes a member element from the NodeSet. Members are compared with Element.equals method.

Parameters:

x - Removes an element equals to element x.

Returns:

true if member was removed. false if not found.

toXMLString

public java.lang.String toXMLString()

Formats the NodeSet in XML format.

Returns:

The sub-tree represented as an XML string