com.sap.cloud.server.odata

Class EnumTypeMap

java.lang.Object

com.sap.cloud.server.odata.MapBase

com.sap.cloud.server.odata.EnumTypeMap

public class EnumTypeMap
extends MapBase

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

Field Summary

Fields

Modifier and Type	Field and Description
static EnumTypeMap	empty

Constructor Summary

Constructors

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

Method Summary

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

Constructor Detail

EnumTypeMap

public EnumTypeMap()

See EnumTypeMap(int).

EnumTypeMap

public EnumTypeMap(int capacity)

Construct a new map with EnumTypeMap.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(EnumType value)

Add an entry to this map using value.localName 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 EnumTypeMap.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 EnumType 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 EnumType 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,
                EnumType value)

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

Parameters:

value - Entry value.

key - Entry key.

setThis

public EnumTypeMap setThis(java.lang.String key,
                           EnumType value)

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

Parameters:

key - Entry key.

value - Entry value.

Returns:

This map.

sortedEntries

public EnumTypeMap.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 EnumTypeList sortedValues()

Return the sorted values of this map.

Returns:

The sorted values of this map.

values

public EnumTypeList values()

Return a list of the entry values in this map.

Returns:

A list of the entry values in this map.