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