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

All Implemented Interfaces:

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

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

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

Class DataValueList

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

DataValueList

DataValueList

Method Detail

add

addAll

addNullable

addThis

castRequired

copy

equal

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

slice

slice

toGeneric

withItemType

withNulls

withType