ComplexValueList (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.ComplexValueList

All Implemented Interfaces:

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

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`ComplexValueList()` See ComplexValueList(int).
`ComplexValueList(int capacity)` Construct a new list with `ComplexValueList.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(ComplexValue item)` Add `item` to the end of this list.
`void`	`addAll(ComplexValueList list)` Add all the items of `list` to the end of this list.
`ComplexValueList`	`addNullable(ComplexValue item)` Append `item` to the end of this list.
`ComplexValueList`	`addThis(ComplexValue item)` Add `item` to the end of this list.
`ComplexValueList`	`applyPageSize(DataQuery query)` Return a new list with at most `query.pageSize` initial items of this list.
`static ComplexValueList`	`castRequired(DataValue value)` For internal use only.
`ComplexValueList`	`copy()` Return a shallow copy of this list.
`static boolean`	`equal(ComplexValueList a, ComplexValueList b)` Return `true` if two complex lists have equal items.
`ComplexValueList`	`filterAndSort(DataQuery query)` Return a new list with the items of this list, filtered by `query.queryFilter` and sorted by `query.sortItems`.
`ComplexValueList`	`filterWithQuery(DataQuery query)` Return a new list with the items of this list, filtered by `query.queryFilter`, `query.derivedType` (whichever of those is specified, if any).
`ComplexValue`	`first()` Return the first item in this list.
`static ComplexValueList`	`from(java.util.List<ComplexValue> list)`
`static ComplexValueList`	`fromNullable(java.util.List<ComplexValue> list)`
`ComplexValue`	`get(int index)` Return the item in this list at the specified `index`.
`DataType`	`getDataType()` Return the data type for this list.
`java.lang.String`	`getNextLink()` Return (nullable) An optional link that can be followed (by the caller) to fetch additional list items.
`ComplexValue`	`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 `ComplexValueList.length` if the client requested an inline `DataQuery.count`.
`boolean`	`includes(ComplexValue item)` Return `true` if this list contains `item`.
`int`	`indexOf(ComplexValue item)` See indexOf(ComplexValue, int).
`int`	`indexOf(ComplexValue item, int start)` Return first index in this list of `item`, or `-1` if not found.
`void`	`insertAll(int index, ComplexValueList list)` Insert all items of `list` into this list, before the item (if any) at `index`.
`void`	`insertAt(int index, ComplexValue item)` Insert `item` into this list, before the item (if any) at `index`.
`boolean`	`isReference()` Return `true` if this list is a referece.
`java.util.Iterator<ComplexValue>`	`iterator()`
`ComplexValue`	`last()` Return the last item in this list.
`int`	`lastIndexOf(ComplexValue item)` See lastIndexOf(ComplexValue, int).
`int`	`lastIndexOf(ComplexValue item, int start)` Return last index in this list of `item`, or `-1` if not found.
`void`	`set(int index, ComplexValue item)` Set the item in this list at the specified `index`.
`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, ComplexValue 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 `ComplexValueList.length` if the client requested an inline `DataQuery.count`.
`static ComplexValueList`	`share(ListBase list)` Return a new `ComplexValueList` that shares the `ListBase.untypedList` as the `list` parameter.
`static ComplexValueList`	`shareNullable(ListBase list)` Return a new ComplexValueList that shares the `ListBase.untypedList` as the `list` parameter, including nulls.
`ComplexValue`	`single()` Return a single item from this list.
`ComplexValueList`	`skipAndTop(DataQuery query)` Return a new list with at most `query.topCount` items of this list, starting at index `query.skipCount`.
`ComplexValueList`	`slice(int start)` See slice(int, int).
`ComplexValueList`	`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<ComplexValue>`	`toGeneric()`
`ComplexValueList`	`withItemType(DataType type)` Override the type of this list, and return this list.
`ComplexValueListWithNulls`	`withNulls()` Return an iterator of this list which uses a nullable item type.
`ComplexValueList`	`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 ComplexValueList empty
```
- Constructor Detail
  - ComplexValueList
```
public ComplexValueList()
```
    See ComplexValueList(int).
  - ComplexValueList
```
public ComplexValueList(int capacity)
```
    Construct a new list with ComplexValueList.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(ComplexValue item)
```
    Add item to the end of this list.
    
    Parameters:
    
    item - Item to be added.
  - addAll
```
public void addAll(ComplexValueList list)
```
    Add all the items of list to the end of this list.
    
    Parameters:
    
    list - Items to be added.
  - addNullable
```
public ComplexValueList addNullable(ComplexValue item)
```
    Append item to the end of this list. It is unusual for a ComplexValueList to contain null items, so ComplexValueList.add is usually used.
    
    Parameters:
    
    item - (nullable) Item to be added, which might be null.
    
    Returns:
    
    This list.
  - addThis
```
public ComplexValueList addThis(ComplexValue item)
```
    Add item to the end of this list.
    
    Parameters:
    
    item - Item to be added.
    
    Returns:
    
    This list.
  - applyPageSize
```
public ComplexValueList applyPageSize(DataQuery query)
```
    Return a new list with at most query.pageSize initial items of this list. The result's ComplexValueList.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 ComplexValueList.needsNextLink will be true if the original list length exceeded the page size.
  - castRequired
```
public static ComplexValueList castRequired(DataValue value)
```
    For internal use only.
    
    Parameters:
    
    value - (internal use only)
    
    Returns:
    
    (internal use only)
  - copy
```
public ComplexValueList copy()
```
    Return a shallow copy of this list.
    
    Returns:
    
    A shallow copy of this list.
  - equal
```
public static boolean equal(ComplexValueList a,
                            ComplexValueList b)
```
    Return true if two complex lists have equal items.
    
    See Also:
    
    ComplexValue.equal.
    
    Parameters:
    
    a - (nullable) First complex list.
    
    b - (nullable) Second complex list.
    
    Returns:
    
    `true` if two complex lists have equal items.
  - filterAndSort
```
public ComplexValueList 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 ComplexValueList filterWithQuery(DataQuery query)
```
    Return a new list with the items of this list, filtered by query.queryFilter, query.derivedType (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 (whichever of those is specified, if any).
  - first
```
public ComplexValue 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 ComplexValueList from(java.util.List<ComplexValue> list)
```
  - fromNullable
```
public static ComplexValueList fromNullable(java.util.List<ComplexValue> list)
```
  - get
```
public ComplexValue get(int index)
```
    Return the item in this list at the specified index.
    
    Throws:
    
    ListIndexException if index is out of range (0 to ComplexValueList.length - 1).
    
    Parameters:
    
    index - Zero-based index.
    
    Returns:
    
    The item in this list at the specified `index`.
  - getDataType
```
public DataType getDataType()
```
    Return the data type for this list.
    
    Overrides:
    
    getDataType in class ListBase
    
    Returns:
    
    The data type for 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 complex 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 ComplexValue getNullable(int index)
```
    Return (nullable) The item in this list at the specified index, which may be null. It is unusual for a ComplexValueList to contain null items, so ComplexValueList.get is usually used.
    
    Throws:
    
    ListIndexException if index is out of range (0 to ComplexValueList.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 ComplexValueList.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 ComplexValueList.length if the client requested an inline DataQuery.count.
  - includes
```
public boolean includes(ComplexValue item)
```
    Return true if this list contains item.
    
    Parameters:
    
    item - Item for comparison. Comparison uses the ComplexValueList.equality property, which would usually be expected to match the == operator for item type ComplexValue.
    
    Returns:
    
    true if this list contains item.
  - indexOf
```
public int indexOf(ComplexValue item)
```
    See indexOf(ComplexValue, int).
    
    Parameters:
    
    item - Item parameter.
    
    Returns:
    
    (see linked method).
  - indexOf
```
public int indexOf(ComplexValue item,
                   int start)
```
    Return first index in this list of item, or -1 if not found.
    
    Parameters:
    
    item - Item for comparison. Comparison uses the ComplexValueList.equality property, which would usually be expected to match the == operator for item type ComplexValue.
    
    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,
                      ComplexValueList 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 ComplexValueList.length).
    
    Parameters:
    
    index - Zero-based index.
    
    list - List of items to be inserted.
  - insertAt
```
public void insertAt(int index,
                     ComplexValue item)
```
    Insert item into this list, before the item (if any) at index.
    
    Throws:
    
    ListIndexException if index is out of range (0 to ComplexValueList.length).
    
    Parameters:
    
    index - Zero-based index.
    
    item - Item to be added.
  - isReference
```
public boolean isReference()
```
    Return true if this list is a referece. If true, the ComplexValueList.readLink will be non-null, and this list will be empty.
    
    Returns:
    
    true if this list is a referece. If true, the ComplexValueList.readLink will be non-null, and this list will be empty.
  - iterator
```
public java.util.Iterator<ComplexValue> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<ComplexValue>
  - last
```
public ComplexValue 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(ComplexValue item)
```
    See lastIndexOf(ComplexValue, int).
    
    Parameters:
    
    item - Item parameter.
    
    Returns:
    
    (see linked method).
  - lastIndexOf
```
public int lastIndexOf(ComplexValue item,
                       int start)
```
    Return last index in this list of item, or -1 if not found.
    
    Parameters:
    
    item - Item for comparison. Comparison uses the ComplexValueList.equality property, which would usually be expected to match the == operator for item type ComplexValue.
    
    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,
                ComplexValue item)
```
    Set the item in this list at the specified index.
    
    Parameters:
    
    index - Zero-based index.
    
    item - Item value.
  - 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 complex 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,
                        ComplexValue item)
```
    Set the item in this list at the specified index. It is unusual for a ComplexValueList to contain null items, so ComplexValueList.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 ComplexValueList.readLink will be non-null, and this list will be empty.
    
    Parameters:
    
    value - true if this list is a referece. If true, the ComplexValueList.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 ComplexValueList.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 ComplexValueList.length if the client requested an inline DataQuery.count.
  - share
```
public static ComplexValueList share(ListBase list)
```
    Return a new ComplexValueList that shares the ListBase.untypedList as the list parameter. To ensure type safety, items in list that do not have the item type ComplexValue will be removed.
    
    Parameters:
    
    list - List whose items will be shared by the resulting list.
    
    Returns:
    
    A new list of item type ComplexValue, sharing the same items as list.
  - shareNullable
```
public static ComplexValueList shareNullable(ListBase list)
```
    Return a new ComplexValueList 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 ComplexValue, sharing the same items as list.
  - single
```
public ComplexValue 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 ComplexValueList 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 ComplexValueList slice(int start)
```
    See slice(int, int).
    
    Parameters:
    
    start - Start parameter.
    
    Returns:
    
    (see linked method).
  - slice
```
public ComplexValueList 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<ComplexValue> toGeneric()
```
  - withItemType
```
public ComplexValueList 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 ComplexValueListWithNulls withNulls()
```
    Return an iterator of this list which uses a nullable item type.
    
    Returns:
    
    An iterator of this list which uses a nullable item type.
  - withType
```
public ComplexValueList withType(DataType type)
```
    Override the type of this list, and return this list.
    
    Parameters:
    
    type - Data type for a list of complex values. Use DataType.listOf to obtain a suitable list type.
    
    Returns:
    
    This list.

Class ComplexValueList

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

ComplexValueList

ComplexValueList

Method Detail

add

addAll

addNullable

addThis

applyPageSize

castRequired

copy

equal

filterAndSort

filterWithQuery

first

from

fromNullable

get

getDataType

getNextLink

getNullable

getReadLink

getTotalCount

includes

indexOf

indexOf

insertAll

insertAt

isReference

iterator

last

lastIndexOf

lastIndexOf

set

setNextLink

setNullable

setReadLink

setReference

setTotalCount

share

shareNullable

single

skipAndTop

slice

slice

sortWithQuery

toGeneric

withItemType

withNulls

withType