org.xins.common.xml

Class ElementList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<Element>

org.xins.common.xml.ElementList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Element>, Collection<Element>, Deque<Element>, List<Element>, Queue<Element>

public class ElementList
extends LinkedList<Element>

An ElementList is an NodeList with the following improvements:

• Implements List which make it iterable with for each loop
• Only includes the direct child of the element
• Only includes the elements
• By default includes all direct child elements
• Preserves the order of the child elements
• Includes a method to get the sub element when unique

Since:

XINS 3.0

Author:

Anthony Goubard

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ElementList(Element element) Creates a list with all direct child element of the given element.
ElementList(Element element, String childName) Creates a list with all direct child element with a specific local name of the given element.

Method Summary

Methods

Modifier and Type	Method and Description
Element	getFirstChildElement() Gets the first child of this element.
Element	getUniqueChildElement() Gets the unique child of this list.

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, 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, isEmpty, iterator, listIterator, removeAll, retainAll, subList

Methods inherited from interface java.util.Deque

iterator

Constructor Detail

ElementList

public ElementList(Element element)

Creates a list with all direct child element of the given element.

Parameters:

element - the parent element, cannot be null.

ElementList

public ElementList(Element element,
           String childName)

Creates a list with all direct child element with a specific local name of the given element.

Parameters:

element - the parent element, cannot be null.

childName - the local name of the direct child elements that should be added to the list, cannot be null.

Method Detail

getUniqueChildElement

public Element getUniqueChildElement()
                              throws ParseException

Gets the unique child of this list.

Returns:

the sub-element of this element list, never null.

Throws:

ParseException - if no child with the specified name was found, or if more than one child with the specified name was found.

getFirstChildElement

public Element getFirstChildElement()

Gets the first child of this element.

Returns:

the sub-element of this element, or null if no element is found.