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