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