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