EntityValueList (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.DataValue
- - com.sap.cloud.server.odata.ListBase
  - - com.sap.cloud.server.odata.EntityValueList

All Implemented Interfaces:

java.lang.Iterable<EntityValue>
```
public class EntityValueList
extends ListBase
implements java.lang.Iterable<EntityValue>
```
A list of item type EntityValue. Uses the property and function naming conventions of the JavaScript Array object.

Field Summary

Fields
Modifier and Type Field and Description

static EntityValueList empty
- Fields inherited from class com.sap.cloud.server.odata.DataValue
  undefined

Fields
Modifier and Type	Field and Description
`static EntityValueList`	`empty`

Constructor Summary

Constructors
Constructor and Description
`EntityValueList()` See EntityValueList(int).
`EntityValueList(int capacity)` Construct a new list with `EntityValueList.length` of zero and optional initial `capacity`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(EntityValue item)` Add `item` to the end of this list.
`void`	`addAll(EntityValueList list)` Add all the items of `list` to the end of this list.
`EntityValueList`	`addNullable(EntityValue item)` Append `item` to the end of this list.
`EntityValueList`	`addThis(EntityValue item)` Add `item` to the end of this list.
`EntityValueList`	`applyPageSize(DataQuery query)` Return a new list with at most `query.pageSize` initial items of this list.
`static EntityValueList`	`castRequired(DataValue value)` For internal use only.
`EntityValueList`	`copy()` Return a shallow copy of this list.
`EntityValueList`	`copyForQuery(DataQuery query, boolean copySelected, boolean copyExpanded)` Return a new list with the items of this list, copied according to the selected properties in the `query`.
`static boolean`	`equal(EntityValueList a, EntityValueList b)` Return `true` if two entity lists have equal items.
`EntityValueList`	`filterAndSort(DataQuery query)` Return a new list with the items of this list, filtered by `query.queryFilter` and sorted by `query.sortItems`.
`EntityValueList`	`filterWithQuery(DataQuery query)` Return a new list with the items of this list, filtered by `query.queryFilter`, `query.derivedType`, `query.entityKey`, `query.deltaTime` (whichever of those is specified, if any).
`EntityValue`	`first()` Return the first item in this list.
`static EntityValueList`	`from(java.util.List<EntityValue> list)`
`static EntityValueList`	`fromNullable(java.util.List<EntityValue> list)`
`EntityValue`	`get(int index)` Return the item in this list at the specified `index`.
`ChangedLinkList`	`getChangedLinks()` Return a list of changed links associated with this entity list.
`DataType`	`getDataType()` Return the data type for this list.
`java.lang.String`	`getDeltaLink()` Return (nullable) An optional link that can be followed (by the caller) to get changes to this list.
`java.lang.String`	`getNextLink()` Return (nullable) An optional link that can be followed (by the caller) to fetch additional list items.
`EntityValue`	`getNullable(int index)` Return (nullable) The item in this list at the specified `index`, which may be `null`.
`java.lang.String`	`getReadLink()` Return (nullable) An optional link that can be followed (by the caller) to re-read this list.
`java.lang.Long`	`getTotalCount()` Return (nullable) Total number of items available in the server-side list, which may be greater than `EntityValueList.length` if the client requested an inline `DataQuery.count`.
`boolean`	`includes(EntityValue item)` Return `true` if this list contains `item`.
`int`	`indexOf(EntityValue item)` See indexOf(EntityValue, int).
`int`	`indexOf(EntityValue item, int start)` Return first index in this list of `item`, or `-1` if not found.
`void`	`insertAll(int index, EntityValueList list)` Insert all items of `list` into this list, before the item (if any) at `index`.
`void`	`insertAt(int index, EntityValue item)` Insert `item` into this list, before the item (if any) at `index`.
`boolean`	`isDelta()` Return `true` if this list is a delta response.
`boolean`	`isReference()` Return `true` if this list is a referece.
`java.util.Iterator<EntityValue>`	`iterator()`
`EntityValue`	`last()` Return the last item in this list.
`int`	`lastIndexOf(EntityValue item)` See lastIndexOf(EntityValue, int).
`int`	`lastIndexOf(EntityValue item, int start)` Return last index in this list of `item`, or `-1` if not found.
`void`	`set(int index, EntityValue item)` Set the item in this list at the specified `index`.
`void`	`setChangedLinks(ChangedLinkList value)` Set a list of changed links associated with this entity list.
`void`	`setDelta(boolean value)` Set `true` if this list is a delta response.
`void`	`setDeltaLink(java.lang.String value)` Set an optional link that can be followed (by the caller) to get changes to this list.
`void`	`setNextLink(java.lang.String value)` Set an optional link that can be followed (by the caller) to fetch additional list items.
`void`	`setNullable(int index, EntityValue item)` Set the item in this list at the specified `index`.
`void`	`setReadLink(java.lang.String value)` Set an optional link that can be followed (by the caller) to re-read this list.
`void`	`setReference(boolean value)` Set `true` if this list is a referece.
`void`	`setTotalCount(java.lang.Long value)` Set total number of items available in the server-side list, which may be greater than `EntityValueList.length` if the client requested an inline `DataQuery.count`.
`static EntityValueList`	`share(ListBase list)` Return a new `EntityValueList` that shares the `ListBase.untypedList` as the `list` parameter.
`static EntityValueList`	`shareNullable(ListBase list)` Return a new EntityValueList that shares the `ListBase.untypedList` as the `list` parameter, including nulls.
`EntityValue`	`single()` Return a single item from this list.
`EntityValueList`	`skipAndTop(DataQuery query)` Return a new list with at most `query.topCount` items of this list, starting at index `query.skipCount`.
`EntityValueList`	`slice(int start)` See slice(int, int).
`EntityValueList`	`slice(int start, int end)` Return a slice of this list from index `start` (inclusive) to index `end` (exclusive).
`void`	`sortWithQuery(DataQuery query)` Sort this list in-place, using `query.sortItems`.
`java.util.List<EntityValue>`	`toGeneric()`
`EntityValueList`	`withItemType(DataType type)` Override the type of this list, and return this list.
`EntityValueListWithNulls`	`withNulls()` Return an iterator of this list which uses a nullable item type.
`EntityValueList`	`withType(DataType type)` Override the type of this list, and return this list.

Methods inherited from class com.sap.cloud.server.odata.ListBase
clear, getComparer, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toDynamic, toString, validate

Methods inherited from class com.sap.cloud.server.odata.DataValue
cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - empty
```
public static final EntityValueList empty
```
- Constructor Detail
  - EntityValueList
```
public EntityValueList()
```
    See EntityValueList(int).
  - EntityValueList
```
public EntityValueList(int capacity)
```
    Construct a new list with EntityValueList.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.
    
    Parameters:
    
    capacity - Optional initial capacity.
- Method Detail
  - add
```
public void add(EntityValue item)
```
    Add item to the end of this list.
    
    Parameters:
    
    item - Item to be added.
  - addAll
```
public void addAll(EntityValueList list)
```
    Add all the items of list to the end of this list.
    
    Parameters:
    
    list - Items to be added.
  - addNullable
```
public EntityValueList addNullable(EntityValue item)
```
    Append item to the end of this list. It is unusual for an EntityValueList to contain null items, so EntityValueList.add is usually used.
    
    Parameters:
    
    item - (nullable) Item to be added, which might be null.
    
    Returns:
    
    This list.
  - addThis
```
public EntityValueList addThis(EntityValue item)
```
    Add item to the end of this list.
    
    Parameters:
    
    item - Item to be added.
    
    Returns:
    
    This list.
  - applyPageSize
```
public EntityValueList applyPageSize(DataQuery query)
```
    Return a new list with at most query.pageSize initial items of this list. The result's EntityValueList.needsNextLink will be true if the original list length exceeded the page size.
    
    Parameters:
    
    query - Data query whose DataQuery.pageSize is used for filtering.
    
    Returns:
    
    A new list with at most query.pageSize initial items of this list. The result's EntityValueList.needsNextLink will be true if the original list length exceeded the page size.
  - castRequired
```
public static EntityValueList castRequired(DataValue value)
```
    For internal use only.
    
    Parameters:
    
    value - (internal use only)
    
    Returns:
    
    (internal use only)
  - copy
```
public EntityValueList copy()
```
    Return a shallow copy of this list.
    
    Returns:
    
    A shallow copy of this list.
  - copyForQuery
```
public EntityValueList copyForQuery(DataQuery query,
                                    boolean copySelected,
                                    boolean copyExpanded)
```
    Return a new list with the items of this list, copied according to the selected properties in the query. A set of the entities to be returned by a DataServlet.executeQuery call may contain values for more properties than requested by the client's query, e.g. if the returned entities are derived from an in-memory structure. In such cases, this function can be helpful to prune the returned properties (in the returned copied entities) to just what the client requested.
    
    Parameters:
    
    query - Data query whose DataQuery.selectItems and DataQuery.expandItems are used for selecting/expanding.
    
    copySelected - Should "selected" (e.g. structural) properties be copied?
    
    copyExpanded - Should "expanded" (e.g. navigation) properties be copied?
    
    Returns:
    
    A new list with the items of this list, copied according to the selected properties in the query.
  - equal
```
public static boolean equal(EntityValueList a,
                            EntityValueList b)
```
    Return true if two entity lists have equal items.
    
    See Also:
    
    EntityValue.equal.
    
    Parameters:
    
    a - (nullable) First entity list.
    
    b - (nullable) Second entity list.
    
    Returns:
    
    `true` if two entity lists have equal items.
  - filterAndSort
```
public EntityValueList filterAndSort(DataQuery query)
```
    Return a new list with the items of this list, filtered by query.queryFilter and sorted by query.sortItems.
    
    Parameters:
    
    query - Data query whose DataQuery.queryFilter is used for filtering and whose DataQuery.sortItems are used for sorting.
    
    Returns:
    
    A new list with the items of this list, filtered by query.queryFilter and sorted by query.sortItems.
  - filterWithQuery
```
public EntityValueList filterWithQuery(DataQuery query)
```
    Return a new list with the items of this list, filtered by query.queryFilter, query.derivedType, query.entityKey, query.deltaTime (whichever of those is specified, if any).
    
    Parameters:
    
    query - Data query used for filtering.
    
    Returns:
    
    A new list with the items of this list, filtered by query.queryFilter, query.derivedType, query.entityKey, query.deltaTime (whichever of those is specified, if any).
  - first
```
public EntityValue first()
```
    Return the first item in this list.
    
    Throws:
    
    EmptyListException if the list is empty.
    
    Returns:
    
    The first item in this list.
  - from
```
public static EntityValueList from(java.util.List<EntityValue> list)
```
  - fromNullable
```
public static EntityValueList fromNullable(java.util.List<EntityValue> list)
```
  - get
```
public EntityValue get(int index)
```
    Return the item in this list at the specified index.
    
    Throws:
    
    ListIndexException if index is out of range (0 to EntityValueList.length - 1).
    
    Parameters:
    
    index - Zero-based index.
    
    Returns:
    
    The item in this list at the specified `index`.
  - getChangedLinks
```
public ChangedLinkList getChangedLinks()
```
    Return a list of changed links associated with this entity list.
    
    Returns:
    
    A list of changed links associated with this entity list.
  - getDataType
```
public DataType getDataType()
```
    Return the data type for this list.
    
    Overrides:
    
    getDataType in class ListBase
    
    Returns:
    
    The data type for this list.
  - getDeltaLink
```
public java.lang.String getDeltaLink()
```
    Return (nullable) An optional link that can be followed (by the caller) to get changes to this list.
    
    Returns:
    
    (nullable) An optional link that can be followed (by the caller) to get changes to this list.
  - getNextLink
```
public java.lang.String getNextLink()
```
    Return (nullable) An optional link that can be followed (by the caller) to fetch additional list items. If this entity list was produced via server-driven paging, then the server may have provided a next-link which can be followed to obtain more items.
    
    Returns:
    
    (nullable) An optional link that can be followed (by the caller) to fetch additional list items.
  - getNullable
```
public EntityValue getNullable(int index)
```
    Return (nullable) The item in this list at the specified index, which may be null. It is unusual for an EntityValueList to contain null items, so EntityValueList.get is usually used.
    
    Throws:
    
    ListIndexException if index is out of range (0 to EntityValueList.length - 1).
    
    Parameters:
    
    index - Zero-based index.
    
    Returns:
    
    (nullable) The item in this list at the specified `index`, which may be `null`.
  - getReadLink
```
public java.lang.String getReadLink()
```
    Return (nullable) An optional link that can be followed (by the caller) to re-read this list.
    
    Returns:
    
    (nullable) An optional link that can be followed (by the caller) to re-read this list.
  - getTotalCount
```
public java.lang.Long getTotalCount()
```
    Return (nullable) Total number of items available in the server-side list, which may be greater than EntityValueList.length if the client requested an inline DataQuery.count.
    
    Returns:
    
    (nullable) Total number of items available in the server-side list, which may be greater than EntityValueList.length if the client requested an inline DataQuery.count.
  - includes
```
public boolean includes(EntityValue item)
```
    Return true if this list contains item.
    
    Parameters:
    
    item - Item for comparison. Comparison uses the EntityValueList.equality property, which would usually be expected to match the == operator for item type EntityValue.
    
    Returns:
    
    true if this list contains item.
  - indexOf
```
public int indexOf(EntityValue item)
```
    See indexOf(EntityValue, int).
    
    Parameters:
    
    item - Item parameter.
    
    Returns:
    
    (see linked method).
  - indexOf
```
public int indexOf(EntityValue item,
                   int start)
```
    Return first index in this list of item, or -1 if not found.
    
    Parameters:
    
    item - Item for comparison. Comparison uses the EntityValueList.equality property, which would usually be expected to match the == operator for item type EntityValue.
    
    start - Zero-based starting index (search moves forwards from this index).
    
    Returns:
    
    First index in this list of item, or -1 if not found.
  - insertAll
```
public void insertAll(int index,
                      EntityValueList list)
```
    Insert all items of list into this list, before the item (if any) at index.
    
    Throws:
    
    ListIndexException if index is out of range (0 to EntityValueList.length).
    
    Parameters:
    
    index - Zero-based index.
    
    list - List of items to be inserted.
  - insertAt
```
public void insertAt(int index,
                     EntityValue item)
```
    Insert item into this list, before the item (if any) at index.
    
    Throws:
    
    ListIndexException if index is out of range (0 to EntityValueList.length).
    
    Parameters:
    
    index - Zero-based index.
    
    item - Item to be added.
  - isDelta
```
public boolean isDelta()
```
    Return true if this list is a delta response.
    
    Returns:
    
    true if this list is a delta response.
  - isReference
```
public boolean isReference()
```
    Return true if this list is a referece. If true, the EntityValueList.readLink will be non-null, and this list will be empty.
    
    Returns:
    
    true if this list is a referece. If true, the EntityValueList.readLink will be non-null, and this list will be empty.
  - iterator
```
public java.util.Iterator<EntityValue> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<EntityValue>
  - last
```
public EntityValue last()
```
    Return the last item in this list.
    
    Throws:
    
    EmptyListException if the list is empty.
    
    Returns:
    
    The last item in this list.
  - lastIndexOf
```
public int lastIndexOf(EntityValue item)
```
    See lastIndexOf(EntityValue, int).
    
    Parameters:
    
    item - Item parameter.
    
    Returns:
    
    (see linked method).
  - lastIndexOf
```
public int lastIndexOf(EntityValue item,
                       int start)
```
    Return last index in this list of item, or -1 if not found.
    
    Parameters:
    
    item - Item for comparison. Comparison uses the EntityValueList.equality property, which would usually be expected to match the == operator for item type EntityValue.
    
    start - Zero-based starting index (search moves backwards from this index).
    
    Returns:
    
    Last index in this list of item, or -1 if not found.
  - set
```
public void set(int index,
                EntityValue item)
```
    Set the item in this list at the specified index.
    
    Parameters:
    
    index - Zero-based index.
    
    item - Item value.
  - setChangedLinks
```
public void setChangedLinks(ChangedLinkList value)
```
    Set a list of changed links associated with this entity list.
    
    Parameters:
    
    value - A list of changed links associated with this entity list.
  - setDelta
```
public void setDelta(boolean value)
```
    Set true if this list is a delta response.
    
    Parameters:
    
    value - true if this list is a delta response.
  - setDeltaLink
```
public void setDeltaLink(java.lang.String value)
```
    Set an optional link that can be followed (by the caller) to get changes to this list.
    
    Parameters:
    
    value - An optional link that can be followed (by the caller) to get changes to this list.
  - setNextLink
```
public void setNextLink(java.lang.String value)
```
    Set an optional link that can be followed (by the caller) to fetch additional list items. If this entity list was produced via server-driven paging, then the server may have provided a next-link which can be followed to obtain more items.
    
    Parameters:
    
    value - An optional link that can be followed (by the caller) to fetch additional list items.
  - setNullable
```
public void setNullable(int index,
                        EntityValue item)
```
    Set the item in this list at the specified index. It is unusual for an EntityValueList to contain null items, so EntityValueList.set is usually used.
    
    Parameters:
    
    index - Zero-based index.
    
    item - (nullable) Item value, which might be null.
  - setReadLink
```
public void setReadLink(java.lang.String value)
```
    Set an optional link that can be followed (by the caller) to re-read this list.
    
    Parameters:
    
    value - An optional link that can be followed (by the caller) to re-read this list.
  - setReference
```
public void setReference(boolean value)
```
    Set true if this list is a referece. If true, the EntityValueList.readLink will be non-null, and this list will be empty.
    
    Parameters:
    
    value - true if this list is a referece. If true, the EntityValueList.readLink will be non-null, and this list will be empty.
  - setTotalCount
```
public void setTotalCount(java.lang.Long value)
```
    Set total number of items available in the server-side list, which may be greater than EntityValueList.length if the client requested an inline DataQuery.count.
    
    Parameters:
    
    value - Total number of items available in the server-side list, which may be greater than EntityValueList.length if the client requested an inline DataQuery.count.
  - share
```
public static EntityValueList share(ListBase list)
```
    Return a new EntityValueList that shares the ListBase.untypedList as the list parameter. To ensure type safety, items in list that do not have the item type EntityValue will be removed.
    
    Parameters:
    
    list - List whose items will be shared by the resulting list.
    
    Returns:
    
    A new list of item type EntityValue, sharing the same items as list.
  - shareNullable
```
public static EntityValueList shareNullable(ListBase list)
```
    Return a new EntityValueList that shares the ListBase.untypedList as the list parameter, including nulls. To ensure type safety, items in list that do not have the item type will be removed.
    
    Parameters:
    
    list - List whose items will be shared by the resulting list.
    
    Returns:
    
    A new list of item type EntityValue, sharing the same items as list.
  - single
```
public EntityValue single()
```
    Return a single item from this list.
    
    Throws:
    
    EmptyListException if the list has no items, NotUniqueException if the list has multiple items.
    
    Returns:
    
    A single item from this list.
  - skipAndTop
```
public EntityValueList skipAndTop(DataQuery query)
```
    Return a new list with at most query.topCount items of this list, starting at index query.skipCount.
    
    Parameters:
    
    query - Data query whose DataQuery.skipCount and DataQuery.topCount are used for filtering.
    
    Returns:
    
    A new list with at most query.topCount items of this list, starting at index query.skipCount.
  - slice
```
public EntityValueList slice(int start)
```
    See slice(int, int).
    
    Parameters:
    
    start - Start parameter.
    
    Returns:
    
    (see linked method).
  - slice
```
public EntityValueList slice(int start,
                             int end)
```
    Return a slice of this list from index start (inclusive) to index end (exclusive).
    
    Parameters:
    
    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.
    
    Returns:
    
    A slice of this list from index start (inclusive) to index end (exclusive).
  - sortWithQuery
```
public void sortWithQuery(DataQuery query)
```
    Sort this list in-place, using query.sortItems.
    
    Parameters:
    
    query - Data query whose whose DataQuery.sortItems are used for filtering.
  - toGeneric
```
public java.util.List<EntityValue> toGeneric()
```
  - withItemType
```
public EntityValueList withItemType(DataType type)
```
    Override the type of this list, and return this list.
    
    Parameters:
    
    type - Data type for the items in this list.
    
    Returns:
    
    This list.
  - withNulls
```
public EntityValueListWithNulls withNulls()
```
    Return an iterator of this list which uses a nullable item type.
    
    See Also:
    
    EntityValueList.share.
    
    Returns:
    
    An iterator of this list which uses a nullable item type.
  - withType
```
public EntityValueList withType(DataType type)
```
    Override the type of this list, and return this list.
    
    Parameters:
    
    type - Data type for a list of entity values. Use DataType.listOf to obtain a suitable list type.
    
    Returns:
    
    This list.

Class EntityValueList

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataValue

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.server.odata.ListBase

Methods inherited from class com.sap.cloud.server.odata.DataValue

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

empty

Constructor Detail

EntityValueList

EntityValueList

Method Detail

add

addAll

addNullable

addThis

applyPageSize

castRequired

copy

copyForQuery

equal

filterAndSort

filterWithQuery

first

from

fromNullable

get

getChangedLinks

getDataType

getDeltaLink

getNextLink

getNullable

getReadLink

getTotalCount

includes

indexOf

indexOf

insertAll

insertAt

isDelta

isReference

iterator

last

lastIndexOf

lastIndexOf

set

setChangedLinks

setDelta

setDeltaLink

setNextLink

setNullable

setReadLink

setReference

setTotalCount

share

shareNullable

single

skipAndTop

slice

slice

sortWithQuery

toGeneric

withItemType

withNulls

withType