com.sap.cloud.server.odata

Class ObjectList

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.ListBase

com.sap.cloud.server.odata.ObjectList

All Implemented Interfaces:

java.lang.Iterable<java.lang.Object>

public class ObjectList
extends ListBase
implements java.lang.Iterable<java.lang.Object>

A list of item type object. Uses the property and function naming conventions of the JavaScript Array object.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectList	empty

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

undefined

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Object item) Add item to the end of this list.
void	addAll(ObjectList list) Add all the items of list to the end of this list.
ObjectList	addThis(java.lang.Object item) Add item to the end of this list.
ObjectList	copy() Return a shallow copy of this list.
java.lang.Object	first() Return the first item in this list.
static ObjectList	from(java.util.List<java.lang.Object> list)
java.lang.Object	get(int index) Return the item in this list at the specified index.
boolean	includes(java.lang.Object item) Return true if this list contains item.
int	indexOf(java.lang.Object item) See indexOf(Object, int).
int	indexOf(java.lang.Object item, int start) Return first index in this list of item, or -1 if not found.
void	insertAll(int index, ObjectList list) Insert all items of list into this list, before the item (if any) at index.
void	insertAt(int index, java.lang.Object item) Insert item into this list, before the item (if any) at index.
java.util.Iterator<java.lang.Object>	iterator()
java.lang.Object	last() Return the last item in this list.
int	lastIndexOf(java.lang.Object item) See lastIndexOf(Object, int).
int	lastIndexOf(java.lang.Object item, int start) Return last index in this list of item, or -1 if not found.
void	set(int index, java.lang.Object item) Set the item in this list at the specified index.
static ObjectList	share(ListBase list) Return a new ObjectList that shares the ListBase.untypedList as the list parameter.
java.lang.Object	single() Return a single item from this list.
ObjectList	slice(int start) See slice(int, int).
ObjectList	slice(int start, int end) Return a slice of this list from index start (inclusive) to index end (exclusive).
java.util.List<java.lang.Object>	toGeneric()

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

clear, getComparer, getDataType, 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 ObjectList empty

Constructor Detail

ObjectList

public ObjectList()

See ObjectList(int).

ObjectList

public ObjectList(int capacity)

Construct a new list with ObjectList.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(java.lang.Object item)

Add item to the end of this list.

Parameters:

item - Item to be added.

addAll

public void addAll(ObjectList list)

Add all the items of list to the end of this list.

Parameters:

list - Items to be added.

addThis

public ObjectList addThis(java.lang.Object item)

Add item to the end of this list.

Parameters:

item - Item to be added.

Returns:

This list.

copy

public ObjectList copy()

Return a shallow copy of this list.

Returns:

A shallow copy of this list.

first

public java.lang.Object 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 ObjectList from(java.util.List<java.lang.Object> list)

get

public java.lang.Object get(int index)

Return the item in this list at the specified index.

Throws:

ListIndexException if index is out of range (0 to ObjectList.length - 1).

Parameters:

index - Zero-based index.

Returns:

The item in this list at the specified `index`.

includes

public boolean includes(java.lang.Object item)

Return true if this list contains item.

Parameters:

item - Item for comparison. Comparison uses the ObjectList.equality property, which would usually be expected to match the == operator for item type object.

Returns:

true if this list contains item.

indexOf

public int indexOf(java.lang.Object item)

See indexOf(Object, int).

Parameters:

item - Item parameter.

Returns:

(see linked method).

indexOf

public int indexOf(java.lang.Object item,
                   int start)

Return first index in this list of item, or -1 if not found.

Parameters:

item - Item for comparison. Comparison uses the ObjectList.equality property, which would usually be expected to match the == operator for item type object.

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,
                      ObjectList 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 ObjectList.length).

Parameters:

index - Zero-based index.

list - List of items to be inserted.

insertAt

public void insertAt(int index,
                     java.lang.Object item)

Insert item into this list, before the item (if any) at index.

Throws:

ListIndexException if index is out of range (0 to ObjectList.length).

Parameters:

index - Zero-based index.

item - Item to be added.

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>

last

public java.lang.Object 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(java.lang.Object item)

See lastIndexOf(Object, int).

Parameters:

item - Item parameter.

Returns:

(see linked method).

lastIndexOf

public int lastIndexOf(java.lang.Object item,
                       int start)

Return last index in this list of item, or -1 if not found.

Parameters:

item - Item for comparison. Comparison uses the ObjectList.equality property, which would usually be expected to match the == operator for item type object.

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,
                java.lang.Object item)

Set the item in this list at the specified index.

Parameters:

index - Zero-based index.

item - Item value.

share

public static ObjectList share(ListBase list)

Return a new ObjectList that shares the ListBase.untypedList as the list parameter. To ensure type safety, items in list that do not have the item type object will be removed.

Parameters:

list - List whose items will be shared by the resulting list.

Returns:

A new list of item type object, sharing the same items as list.

single

public java.lang.Object 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 ObjectList slice(int start)

See slice(int, int).

Parameters:

start - Start parameter.

Returns:

(see linked method).

slice

public ObjectList 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<java.lang.Object> toGeneric()