com.sap.cloud.environment.servicebinding.api

Class TypedListView

java.lang.Object

com.sap.cloud.environment.servicebinding.api.TypedListView

public final class TypedListView
extends Object

A utility class that allows type-safe access to items of a List.

Method Summary

Modifier and Type	Method and Description
Object	get(int index) Returns the item at the given index.
boolean	getBoolean(int index) Returns the item at the given index as a boolean.
double	getDouble(int index) Returns the item at the given index as a double.
int	getInteger(int index) Returns the item at the given index as an int.
<T> List<T>	getItems(Class<? extends T> itemType) Returns all items that are of the given itemType - including sub-types.
TypedListView	getListView(int index) Returns the item at the given index as a TypedListView.
TypedMapView	getMapView(int index) Returns the item at the given index as a TypedMapView.
Number	getNumber(int index) Returns the item at the given index as a Number.
int	getSize() Returns the size of the underlying List.
String	getString(int index) Returns the item at the given index as a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBoolean

public boolean getBoolean(int index)
                   throws IndexOutOfBoundsException,
                          ValueCastException

Returns the item at the given index as a boolean.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as a boolean.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not a boolean.

get

@Nullable
public Object get(int index)
                     throws IndexOutOfBoundsException

Returns the item at the given index.

Parameters:

index - The list index of the item.

Returns:

The item at the given index.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

getSize

public int getSize()

Returns the size of the underlying List.

Returns:

The size of the underlying List.

getInteger

public int getInteger(int index)
               throws IndexOutOfBoundsException,
                      ValueCastException

Returns the item at the given index as an int.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as an int.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not an int.

getNumber

@Nonnull
public Number getNumber(int index)
                          throws IndexOutOfBoundsException,
                                 ValueCastException

Returns the item at the given index as a Number.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as a Number.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not a Number.

getDouble

public double getDouble(int index)
                 throws IndexOutOfBoundsException,
                        ValueCastException

Returns the item at the given index as a double.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as a double.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not a double.

getString

@Nonnull
public String getString(int index)
                          throws IndexOutOfBoundsException,
                                 ValueCastException

Returns the item at the given index as a String.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as a String.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not a String.

getMapView

@Nonnull
public TypedMapView getMapView(int index)
                                 throws IndexOutOfBoundsException,
                                        ValueCastException

Returns the item at the given index as a TypedMapView.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as a TypedMapView.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not a TypedMapView.

getListView

@Nonnull
public TypedListView getListView(int index)
                                   throws IndexOutOfBoundsException,
                                          ValueCastException

Returns the item at the given index as a TypedListView.

Parameters:

index - The list index of the item.

Returns:

The item at the given index as a TypedListView.

Throws:

IndexOutOfBoundsException - Thrown if the given index is out of bounds.

ValueCastException - Thrown if the item is not a TypedListView.

getItems

@Nonnull
public <T> List<T> getItems(@Nonnull
                                     Class<? extends T> itemType)

Returns all items that are of the given itemType - including sub-types.

Type Parameters:

T - The item type.

Parameters:

itemType - The Class of the items that should be returned.

Returns:

All items contained in this TypedMapView that are of (a sub-)type of the given itemType.