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