com.sap.client.odata.v4

Class StringMap.EntryList

java.lang.Object

com.sap.client.odata.v4.DataValue

com.sap.client.odata.v4.ListBase

com.sap.client.odata.v4.StringMap.EntryList

All Implemented Interfaces:

java.lang.Iterable<StringMap.Entry>

Enclosing class:

StringMap

public static class StringMap.EntryList
extends ListBase
implements java.lang.Iterable<StringMap.Entry>

A list of item type StringMap.Entry.

Field Summary

Fields

Modifier and Type	Field and Description
static StringMap.EntryList	empty

Fields inherited from class com.sap.client.odata.v4.DataValue

undefined

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.sap.client.odata.v4.ListBase

clear, getComparer, getDataType, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toString, validate

Methods inherited from class com.sap.client.odata.v4.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 StringMap.EntryList empty

Constructor Detail

EntryList

public EntryList()

See StringMap.EntryList(int).

EntryList

public EntryList(int capacity)

Construct a new list with StringMap$EntryList.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(StringMap.Entry item)

Add item to the end of this list.

Parameters:

item - Item to be added.

addAll

public void addAll(StringMap.EntryList list)

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

Parameters:

list - Items to be added.

addThis

public StringMap.EntryList addThis(StringMap.Entry item)

Add item to the end of this list.

Parameters:

item - Item to be added.

Returns:

This list.

copy

public StringMap.EntryList copy()

Return a shallow copy of this list.

Returns:

A shallow copy of this list.

first

public StringMap.Entry 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 StringMap.EntryList from(java.util.List<StringMap.Entry> list)

get

public StringMap.Entry get(int index)

Return the item in this list at the specified index.

Throws:

ListIndexException if index is out of range (0 to StringMap$EntryList.length - 1).

Parameters:

index - Zero-based index.

Returns:

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

includes

public boolean includes(StringMap.Entry item)

Return true if this list contains item.

Parameters:

item - Item for comparison. Comparison uses the StringMap$EntryList.equality property, which would usually be expected to match the == operator for item type StringMap.Entry.

Returns:

true if this list contains item.

indexOf

public int indexOf(StringMap.Entry item)

See indexOf(Entry, int).

indexOf

public int indexOf(StringMap.Entry item,
                   int start)

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

Parameters:

item - Item for comparison. Comparison uses the StringMap$EntryList.equality property, which would usually be expected to match the == operator for item type StringMap.Entry.

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,
                      StringMap.EntryList 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 StringMap$EntryList.length).

Parameters:

index - Zero-based index.

list - List of items to be inserted.

insertAt

public void insertAt(int index,
                     StringMap.Entry item)

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

Throws:

ListIndexException if index is out of range (0 to StringMap$EntryList.length).

Parameters:

index - Zero-based index.

item - Item to be added.

iterator

public java.util.Iterator<StringMap.Entry> iterator()

Specified by:

iterator in interface java.lang.Iterable<StringMap.Entry>

last

public StringMap.Entry 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(StringMap.Entry item)

See lastIndexOf(Entry, int).

lastIndexOf

public int lastIndexOf(StringMap.Entry item,
                       int start)

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

Parameters:

item - Item for comparison. Comparison uses the StringMap$EntryList.equality property, which would usually be expected to match the == operator for item type StringMap.Entry.

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,
                StringMap.Entry item)

Set the item in this list at the specified index.

Parameters:

index - Zero-based index.

item - Item value.

share

public static StringMap.EntryList share(ListBase list)

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

Parameters:

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

Returns:

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

single

public StringMap.Entry 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 StringMap.EntryList slice(int start)

See slice(int, int).

slice

public StringMap.EntryList 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<StringMap.Entry> toGeneric()