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