io.openmessaging

Interface KeyValue

public interface KeyValue

The KeyValue class represents a persistent set of attributes, which supports method chaining.

A KeyValue object only allows String keys and can contain four primitive type as values: int, long, double, String.

The KeyValue is a replacement of Properties, with simpler interfaces and reasonable entry limits.

A KeyValue object may be used in concurrent scenarios, so the implementation of KeyValue should consider concurrent related issues.

Since:

OMS 1.0.0

Version:

OMS 1.0.0

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Tests if the specified String is a key in this KeyValue.
double	getDouble(String key) Searches for the double property with the specified key in this KeyValue object.
double	getDouble(String key, double defaultValue) Searches for the double property with the specified key in this KeyValue object.
int	getInt(String key) Searches for the int property with the specified key in this KeyValue object.
int	getInt(String key, int defaultValue) Searches for the int property with the specified key in this KeyValue object.
long	getLong(String key) Searches for the long property with the specified key in this KeyValue object.
long	getLong(String key, long defaultValue) Searches for the long property with the specified key in this KeyValue object.
String	getString(String key) Searches for the String property with the specified key in this KeyValue object.
String	getString(String key, String defaultValue) Searches for the String property with the specified key in this KeyValue object.
Set<String>	keySet() Returns a Set view of the keys contained in this KeyValue object.
KeyValue	put(String key, double value) Inserts or replaces double value for the specified key.
KeyValue	put(String key, int value) Inserts or replaces int value for the specified key.
KeyValue	put(String key, long value) Inserts or replaces long value for the specified key.
KeyValue	put(String key, String value) Inserts or replaces String value for the specified key.

Method Detail

put

KeyValue put(String key,
             int value)

Inserts or replaces int value for the specified key.

Parameters:

key - the key to be placed into this KeyValue object

value - the value corresponding to key

put

KeyValue put(String key,
             long value)

Inserts or replaces long value for the specified key.

Parameters:

key - the key to be placed into this KeyValue object

value - the value corresponding to key

put

KeyValue put(String key,
             double value)

Inserts or replaces double value for the specified key.

Parameters:

key - the key to be placed into this KeyValue object

value - the value corresponding to key

put

KeyValue put(String key,
             String value)

Inserts or replaces String value for the specified key.

Parameters:

key - the key to be placed into this KeyValue object

value - the value corresponding to key

getInt

int getInt(String key)

Searches for the int property with the specified key in this KeyValue object. If the key is not found in this property list, zero is returned.

Parameters:

key - the property key

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, int)

getInt

int getInt(String key,
           int defaultValue)

Searches for the int property with the specified key in this KeyValue object. If the key is not found in this property list, the default value argument is returned.

Parameters:

key - the property key

defaultValue - a default value

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, int)

getLong

long getLong(String key)

Searches for the long property with the specified key in this KeyValue object. If the key is not found in this property list, zero is returned.

Parameters:

key - the property key

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, long)

getLong

long getLong(String key,
             long defaultValue)

Searches for the long property with the specified key in this KeyValue object. If the key is not found in this property list, the default value argument is returned.

Parameters:

key - the property key

defaultValue - a default value

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, long)

getDouble

double getDouble(String key)

Searches for the double property with the specified key in this KeyValue object. If the key is not found in this property list, zero is returned.

Parameters:

key - the property key

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, double)

getDouble

double getDouble(String key,
                 double defaultValue)

Searches for the double property with the specified key in this KeyValue object. If the key is not found in this property list, the default value argument is returned.

Parameters:

key - the property key

defaultValue - a default value

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, double)

getString

String getString(String key)

Searches for the String property with the specified key in this KeyValue object. If the key is not found in this property list, null is returned.

Parameters:

key - the property key

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, String)

getString

String getString(String key,
                 String defaultValue)

Searches for the String property with the specified key in this KeyValue object. If the key is not found in this property list, the default value argument is returned.

Parameters:

key - the property key

defaultValue - a default value

Returns:

the value in this KeyValue object with the specified key value

See Also:

put(String, String)

keySet

Set<String> keySet()

Returns a Set view of the keys contained in this KeyValue object.

The set is backed by the KeyValue, so changes to the set are reflected in the @code KeyValue}, and vice-versa.

Returns:

the key set view of this KeyValue object.

containsKey

boolean containsKey(String key)

Tests if the specified String is a key in this KeyValue.

Parameters:

key - possible key

Returns:

true if and only if the specified key is in this KeyValue, false otherwise.