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