public class XmlNodeList extends ListBase implements java.lang.Iterable<XmlNode>
A list of item type XmlNode.
Uses the property and function naming conventions of the JavaScript Array object.
| Modifier and Type | Field and Description |
|---|---|
static XmlNodeList |
empty |
| Constructor and Description |
|---|
XmlNodeList()
See XmlNodeList(int).
|
XmlNodeList(int capacity)
Construct a new list with
XmlNodeList.length of zero and optional initial capacity. |
| Modifier and Type | Method and Description |
|---|---|
void |
add(XmlNode item)
Add
item to the end of this list. |
void |
addAll(XmlNodeList list)
Add all the items of
list to the end of this list. |
XmlNodeList |
addThis(XmlNode item)
Add
item to the end of this list. |
XmlNodeList |
copy()
Return a shallow copy of this list.
|
XmlNode |
first()
Return the first item in this list.
|
static XmlNodeList |
from(java.util.List<XmlNode> list) |
XmlNode |
get(int index)
Return the item in this list at the specified
index. |
boolean |
includes(XmlNode item)
Return
true if this list contains item. |
int |
indexOf(XmlNode item)
|
int |
indexOf(XmlNode item,
int start)
Return first index in this list of
item, or -1 if not found. |
void |
insertAll(int index,
XmlNodeList list)
Insert all items of
list into this list, before the item (if any) at index. |
void |
insertAt(int index,
XmlNode item)
Insert
item into this list, before the item (if any) at index. |
java.util.Iterator<XmlNode> |
iterator() |
XmlNode |
last()
Return the last item in this list.
|
int |
lastIndexOf(XmlNode item)
|
int |
lastIndexOf(XmlNode item,
int start)
Return last index in this list of
item, or -1 if not found. |
void |
set(int index,
XmlNode item)
Set the item in this list at the specified
index. |
static XmlNodeList |
share(ListBase list)
|
XmlNode |
single()
Return a single item from this list.
|
XmlNodeList |
slice(int start)
See slice(int, int).
|
XmlNodeList |
slice(int start,
int end)
Return a slice of this list from index
start (inclusive) to index end (exclusive). |
java.util.List<XmlNode> |
toGeneric() |
clear, getComparer, getDataType, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toDynamic, toString, validatecloneMutable, equals, getTypeCode, hashCodepublic static final XmlNodeList empty
public XmlNodeList()
public XmlNodeList(int capacity)
Construct a new list with XmlNodeList.length of zero and optional initial capacity.
A list can expand in length beyond its initial capacity, but best performance
will be obtained if the initial capacity is close to the list's maximum length.
capacity - Optional initial capacity.public void add(XmlNode item)
Add item to the end of this list.
item - Item to be added.public void addAll(XmlNodeList list)
Add all the items of list to the end of this list.
list - Items to be added.public XmlNodeList addThis(XmlNode item)
Add item to the end of this list.
item - Item to be added.public XmlNodeList copy()
Return a shallow copy of this list.
public XmlNode first()
Return the first item in this list.
EmptyListException if the list is empty.
public static XmlNodeList from(java.util.List<XmlNode> list)
public XmlNode get(int index)
Return the item in this list at the specified index.
ListIndexException if index is out of range (0 to XmlNodeList.length - 1).
index - Zero-based index.public boolean includes(XmlNode item)
Return true if this list contains item.
item - Item for comparison. Comparison uses the XmlNodeList.equality property, which would usually be expected to match the == operator for item type XmlNode.true if this list contains item.public int indexOf(XmlNode item)
item - Item parameter.public int indexOf(XmlNode item, int start)
Return first index in this list of item, or -1 if not found.
item - Item for comparison. Comparison uses the XmlNodeList.equality property, which would usually be expected to match the == operator for item type XmlNode.start - Zero-based starting index (search moves forwards from this index).item, or -1 if not found.public void insertAll(int index,
XmlNodeList list)
Insert all items of list into this list, before the item (if any) at index.
ListIndexException if index is out of range (0 to XmlNodeList.length).
index - Zero-based index.list - List of items to be inserted.public void insertAt(int index,
XmlNode item)
Insert item into this list, before the item (if any) at index.
ListIndexException if index is out of range (0 to XmlNodeList.length).
index - Zero-based index.item - Item to be added.public java.util.Iterator<XmlNode> iterator()
iterator in interface java.lang.Iterable<XmlNode>public XmlNode last()
Return the last item in this list.
EmptyListException if the list is empty.
public int lastIndexOf(XmlNode item)
item - Item parameter.public int lastIndexOf(XmlNode item, int start)
Return last index in this list of item, or -1 if not found.
item - Item for comparison. Comparison uses the XmlNodeList.equality property, which would usually be expected to match the == operator for item type XmlNode.start - Zero-based starting index (search moves backwards from this index).item, or -1 if not found.public void set(int index,
XmlNode item)
Set the item in this list at the specified index.
index - Zero-based index.item - Item value.public static XmlNodeList share(ListBase list)
Return a new XmlNodeList that shares the ListBase.untypedList as the list parameter.
To ensure type safety, items in list that do not have the item type XmlNode will be removed.
list - List whose items will be shared by the resulting list.XmlNode, sharing the same items as list.public XmlNode single()
Return a single item from this list.
EmptyListException if the list has no items, NotUniqueException if the list has multiple items.
public XmlNodeList slice(int start)
start - Start parameter.public XmlNodeList slice(int start, int end)
Return a slice of this list from index start (inclusive) to index end (exclusive).
start - Zero-based starting index (inclusive), or negative for starting index relative to the end of this list.end - Zero-based ending index (exclusive), or negative for ending index relative to the end of this list.start (inclusive) to index end (exclusive).public java.util.List<XmlNode> toGeneric()