com.sap.cloud.server.odata

Class ObjectMap

java.lang.Object

com.sap.cloud.server.odata.MapBase

com.sap.cloud.server.odata.ObjectMap

public class ObjectMap
extends MapBase

A map from key type string to value type object. Uses the property and function naming conventions of the JavaScript Map object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectMap.Entry A key/value pair for map entries.
static class	ObjectMap.EntryList A list of item type ObjectMap.Entry.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectMap	empty

Constructor Summary

Constructors

Constructor and Description
ObjectMap() See ObjectMap(int).
ObjectMap(int capacity) Construct a new map with ObjectMap.size of zero and optional initial capacity.

Method Summary

Modifier and Type	Method and Description
boolean	delete(java.lang.String key) Delete the entry with the specified key (if found).
ObjectMap.EntryList	entries() Return a list of the entries (key/value pairs) in this map.
java.lang.Object	get(java.lang.String key) Return (nullable) The value from the entry with the specified key (if found), otherwise null.
java.lang.Object	getRequired(java.lang.String key) Return the value from the entry with the specified key (if found).
com.sap.cloud.server.odata.core.UntypedMap	getUntypedMap() Return the underlying untyped map of objects.
boolean	has(java.lang.String key) Return true if this map has an entry with the specified key, otherwise false.
StringList	keys() Return a list of the entry keys in this map.
void	set(java.lang.String key, java.lang.Object value) Add or replace an entry with the specified key and value.
ObjectMap	setThis(java.lang.String key, java.lang.Object value) Add or replace an entry with the specified key and value.
ObjectMap.EntryList	sortedEntries() Return the entries of this map sorted by key.
ObjectList	values() Return a list of the entry values in this map.

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

clear, isEmpty, size, toString

Methods inherited from class java.lang.Object

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

Field Detail

empty

public static final ObjectMap empty

Constructor Detail

ObjectMap

public ObjectMap()

See ObjectMap(int).

ObjectMap

public ObjectMap(int capacity)

Construct a new map with ObjectMap.size of zero and optional initial capacity. A map can expand in size beyond its initial capacity, but best performance will be obtained if the initial capacity is close to the map's maximum size.

Parameters:

capacity - Optional initial capacity.

Method Detail

delete

public boolean delete(java.lang.String key)

Delete the entry with the specified key (if found).

Parameters:

key - Entry key.

Returns:

true if an entry with the specified key was found (and deleted).

entries

public ObjectMap.EntryList entries()

Return a list of the entries (key/value pairs) in this map.

Returns:

A list of the entries (key/value pairs) in this map.

get

public java.lang.Object get(java.lang.String key)

Return (nullable) The value from the entry with the specified key (if found), otherwise null.

Parameters:

key - Entry key.

Returns:

(nullable) The value from the entry with the specified key (if found), otherwise null.

getRequired

public java.lang.Object getRequired(java.lang.String key)

Return the value from the entry with the specified key (if found).

Throws:

MissingEntryException if no entry is found for the specified key.

Parameters:

key - Entry key.

Returns:

The value from the entry with the specified `key` (if found).

getUntypedMap

public com.sap.cloud.server.odata.core.UntypedMap getUntypedMap()

Return the underlying untyped map of objects. Use with care, avoiding the addition of objects with an incorrect item type.

Specified by:

getUntypedMap in class MapBase

Returns:

The underlying untyped map of objects. Use with care, avoiding the addition of objects with an incorrect item type.

has

public boolean has(java.lang.String key)

Return true if this map has an entry with the specified key, otherwise false.

Parameters:

key - Entry key.

Returns:

true if this map has an entry with the specified key, otherwise false.

keys

public StringList keys()

Return a list of the entry keys in this map.

Returns:

A list of the entry keys in this map.

set

public void set(java.lang.String key,
                java.lang.Object value)

Add or replace an entry with the specified key and value.

Parameters:

value - Entry value.

key - Entry key.

setThis

public ObjectMap setThis(java.lang.String key,
                         java.lang.Object value)

Add or replace an entry with the specified key and value.

Parameters:

key - Entry key.

value - Entry value.

Returns:

This map.

sortedEntries

public ObjectMap.EntryList sortedEntries()

Return the entries of this map sorted by key.

Returns:

The entries of this map sorted by key.

values

public ObjectList values()

Return a list of the entry values in this map.

Returns:

A list of the entry values in this map.