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