com.sap.cloud.environment.servicebinding.api

Class TypedMapView

java.lang.Object

com.sap.cloud.environment.servicebinding.api.TypedMapView

public final class TypedMapView
extends Object

A utility class that allows type-safe access to entries of a Map.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Checks whether the given key is contained in this TypedMapView.
Object	get(String key) Returns the entry that is stored under the given key.
boolean	getBoolean(String key) Returns the entry that is stored under the given key as a boolean.
double	getDouble(String key) Returns the entry that is stored under the given key as a double.
<T> Map<String,T>	getEntries(Class<? extends T> entryType) Returns a Map of entries (including their key) that are of the given entryType - including sub-types.
int	getInteger(String key) Returns the entry that is stored under the given key as an int.
Set<String>	getKeys() Returns an immutable Set of keys, which are contained in this TypedMapView.
TypedListView	getListView(String key) Returns the entry that is stored under the given key as a TypedListView.
TypedMapView	getMapView(String key) Returns the entry that is stored under the given key as a TypedMapView.
Number	getNumber(String key) Returns the entry that is stored under the given key as a Number.
String	getString(String key) Returns the entry that is stored under the given key as a String.
static TypedMapView	of(ServiceBinding serviceBinding) Initializes a new TypedMapView instance from the given serviceBinding.
static TypedMapView	ofCredentials(ServiceBinding serviceBinding) Initializes a new TypedMapView instance from the ServiceBinding.getCredentials() of the given serviceBinding.

Methods inherited from class java.lang.Object

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

Method Detail

of

@Nonnull
public static TypedMapView of(@Nonnull
                                       ServiceBinding serviceBinding)

Initializes a new TypedMapView instance from the given serviceBinding.

Parameters:

serviceBinding - The ServiceBinding, which should be converted.

Returns:

A new TypedMapView instance.

ofCredentials

@Nonnull
public static TypedMapView ofCredentials(@Nonnull
                                                  ServiceBinding serviceBinding)

Initializes a new TypedMapView instance from the ServiceBinding.getCredentials() of the given serviceBinding.

Parameters:

serviceBinding - The ServiceBinding to take the credentials from.

Returns:

A new TypedMapView instance.

getKeys

@Nonnull
public Set<String> getKeys()

Returns an immutable Set of keys, which are contained in this TypedMapView.

Returns:

An immutable Set of keys.

getBoolean

public boolean getBoolean(@Nonnull
                          String key)
                   throws KeyNotFoundException,
                          ValueCastException

Returns the entry that is stored under the given key as a boolean.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as a boolean.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not a boolean.

get

@Nullable
public Object get(@Nonnull
                            String key)
                     throws KeyNotFoundException

Returns the entry that is stored under the given key.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

containsKey

public boolean containsKey(@Nonnull
                           String key)

Checks whether the given key is contained in this TypedMapView.

Parameters:

key - The key to check.

Returns:

true if the key is contained, false otherwise.

getInteger

public int getInteger(@Nonnull
                      String key)
               throws KeyNotFoundException,
                      ValueCastException

Returns the entry that is stored under the given key as an int.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as an int.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not an int.

getNumber

@Nonnull
public Number getNumber(@Nonnull
                                 String key)
                          throws KeyNotFoundException,
                                 ValueCastException

Returns the entry that is stored under the given key as a Number.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as a Number.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not a Number.

getDouble

public double getDouble(@Nonnull
                        String key)
                 throws KeyNotFoundException,
                        ValueCastException

Returns the entry that is stored under the given key as a double.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as a double.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not a double.

getString

@Nonnull
public String getString(@Nonnull
                                 String key)
                          throws KeyNotFoundException,
                                 ValueCastException

Returns the entry that is stored under the given key as a String.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as a String.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not a String.

getMapView

@Nonnull
public TypedMapView getMapView(@Nonnull
                                        String key)
                                 throws KeyNotFoundException,
                                        ValueCastException

Returns the entry that is stored under the given key as a TypedMapView.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as a TypedMapView.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not a TypedMapView.

getListView

@Nonnull
public TypedListView getListView(@Nonnull
                                          String key)
                                   throws KeyNotFoundException,
                                          ValueCastException

Returns the entry that is stored under the given key as a TypedListView.

Parameters:

key - The key of the entry.

Returns:

The entry that is stored under the given key as a TypedListView.

Throws:

KeyNotFoundException - Thrown if the given key is not contained in this TypedMapView.

ValueCastException - Thrown if the entry is not a TypedListView.

getEntries

@Nonnull
public <T> Map<String,T> getEntries(@Nonnull
                                             Class<? extends T> entryType)

Returns a Map of entries (including their key) that are of the given entryType - including sub-types.

Type Parameters:

T - The entry type.

Parameters:

entryType - The Class of the entries that should be returned.

Returns:

A Map of all entries (including their keys) contained in this TypedMapView that are of (a sub-)type of the given entryType.