com.sap.cloud.server.odata

Class DataTypeList

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.ListBase

com.sap.cloud.server.odata.DataTypeList

All Implemented Interfaces:

java.lang.Iterable<DataType>

public class DataTypeList
extends ListBase
implements java.lang.Iterable<DataType>

For internal use only.

Field Summary

Fields

Modifier and Type	Field and Description
static DataTypeList	empty

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

undefined

Constructor Summary

Constructors

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

Method Summary

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

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

clear, 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 DataTypeList empty

Constructor Detail

DataTypeList

public DataTypeList()

See DataTypeList(int).

DataTypeList

public DataTypeList(int capacity)

Construct a new list with DataTypeList.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(DataType item)

Add item to the end of this list.

Parameters:

item - Item to be added.

addAll

public void addAll(DataTypeList list)

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

Parameters:

list - Items to be added.

addThis

public DataTypeList addThis(DataType item)

Add item to the end of this list.

Parameters:

item - Item to be added.

Returns:

This list.

copy

public DataTypeList copy()

Return a shallow copy of this list.

Returns:

A shallow copy of this list.

first

public DataType 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 DataTypeList from(java.util.List<DataType> list)

get

public DataType get(int index)

Return the item in this list at the specified index.

Throws:

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

Parameters:

index - Zero-based index.

Returns:

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

getComparer

public com.sap.cloud.server.odata.core.Comparer getComparer()

Return an ordering function for the item type of this list.

Overrides:

getComparer in class ListBase

Returns:

An ordering function for the item type of this list.

includes

public boolean includes(DataType item)

Return true if this list contains item.

Parameters:

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

Returns:

true if this list contains item.

indexOf

public int indexOf(DataType item)

See indexOf(DataType, int).

Parameters:

item - Item parameter.

Returns:

(see linked method).

indexOf

public int indexOf(DataType item,
                   int start)

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

Parameters:

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

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

Parameters:

index - Zero-based index.

list - List of items to be inserted.

insertAt

public void insertAt(int index,
                     DataType item)

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

Throws:

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

Parameters:

index - Zero-based index.

item - Item to be added.

iterator

public java.util.Iterator<DataType> iterator()

Specified by:

iterator in interface java.lang.Iterable<DataType>

last

public DataType 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(DataType item)

See lastIndexOf(DataType, int).

Parameters:

item - Item parameter.

Returns:

(see linked method).

lastIndexOf

public int lastIndexOf(DataType item,
                       int start)

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

Parameters:

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

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,
                DataType item)

Set the item in this list at the specified index.

Parameters:

index - Zero-based index.

item - Item value.

share

public static DataTypeList share(ListBase list)

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

Parameters:

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

Returns:

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

single

public DataType 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 DataTypeList slice(int start)

See slice(int, int).

Parameters:

start - Start parameter.

Returns:

(see linked method).

slice

public DataTypeList 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<DataType> toGeneric()