com.sap.cloud.server.odata

Class EnumValueMap

java.lang.Object

com.sap.cloud.server.odata.MapBase

com.sap.cloud.server.odata.EnumValueMap

public class EnumValueMap
extends MapBase

A map from key type string to value type EnumValue. 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	EnumValueMap.Entry A key/value pair for map entries.
static class	EnumValueMap.EntryList A list of item type EnumValueMap.Entry.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumValueMap	empty

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(EnumValue value) Add an entry to this map using value.name as the entry key and value as the entry value.
boolean	delete(java.lang.String key) Delete the entry with the specified key (if found).
EnumValueMap.EntryList	entries() Return a list of the entries (key/value pairs) in this map.
EnumValue	get(java.lang.String key) Return (nullable) The value from the entry with the specified key (if found), otherwise null.
EnumValue	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, EnumValue value) Add or replace an entry with the specified key and value.
EnumValueMap	setThis(java.lang.String key, EnumValue value) Add or replace an entry with the specified key and value.
EnumValueMap.EntryList	sortedEntries() Return the entries of this map sorted by key.
StringList	sortedKeys() Return the sorted keys of this map.
EnumValueList	sortedValues() Return the sorted values of this map.
EnumValueList	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 EnumValueMap empty

Constructor Detail

EnumValueMap

public EnumValueMap()

See EnumValueMap(int).

EnumValueMap

public EnumValueMap(int capacity)

Construct a new map with EnumValueMap.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

add

public void add(EnumValue value)

Add an entry to this map using value.name as the entry key and value as the entry value.

Parameters:

value - Value for new map entry.

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 EnumValueMap.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 EnumValue 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 EnumValue 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,
                EnumValue value)

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

Parameters:

value - Entry value.

key - Entry key.

setThis

public EnumValueMap setThis(java.lang.String key,
                            EnumValue value)

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

Parameters:

key - Entry key.

value - Entry value.

Returns:

This map.

sortedEntries

public EnumValueMap.EntryList sortedEntries()

Return the entries of this map sorted by key.

Returns:

The entries of this map sorted by key.

sortedKeys

public StringList sortedKeys()

Return the sorted keys of this map.

Returns:

The sorted keys of this map.

sortedValues

public EnumValueList sortedValues()

Return the sorted values of this map.

Returns:

The sorted values of this map.

values

public EnumValueList values()

Return a list of the entry values in this map.

Returns:

A list of the entry values in this map.