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