ilog.server.jcomp
Class MvKeyValueTable

java.lang.Object
  |
  +--ilog.server.jcomp.MvUserType
        |
        +--ilog.server.jcomp.MvKeyValueTable

All Implemented Interfaces:

Cloneable, Map, ilog.server.jcomp.Streamable

public class MvKeyValueTable

extends MvUserType

implements Map

This class carries out the association between a key and a value, based on the Map interface. The key and value are of the MvValue type, thus allowing the use of this class in a large variety of cases. All instances of subclasses of MvUserType can also be used as keys or values. This kind of table can be transmitted between Rogue Wave Server processed.

Inner classes inherited from class java.util.Map

Map.Entry

Field Summary

protected Map

_map

Constructor Summary

MvKeyValueTable()
This constructor initializes an empty table.

MvKeyValueTable(List orig)
This constructor initializes the MvKeyValueTable instance with orig.

MvKeyValueTable(Map orig)
Copy constructor.

MvKeyValueTable(MvKeyValueTable orig)
Copy constructor.

Method Summary

void	clear() Removes all mappings from this map (optional operation).
boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(Object value) Returns true if this map maps one or more keys to the specified value.
static MvKeyValueTable	Decode(MvMessage msg)
static MvKeyValueTable	DeepClone(Map map)
MvMessage	encode(MvMessage msg) Writes an instance into an MvMessage for transfer to another process.
Set	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(Object o) Compares the specified object with this map to check whether they are equal.
Object	get(Object key) Returns the value to which this map maps the specified key.
int	hashCode() Returns the hash code value for this map.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
Set	keySet() Returns a set view of the keys contained in this map.
Object	put(Object key, Object value) Associates the specified value with the specified key in this map (optional operation).
void	putAll(Map t) Copies all the mappings from the specified map to this map (optional operation).
Object	remove(Object key) Removes the mapping for this key from the map if one exists (optional operation).
int	size() Returns the number of key-value mappings in this map.
protected MvArray	toMvArray()
Collection	values() Returns a collection view of the values contained in this map.

Methods inherited from class ilog.server.jcomp.MvUserType

asAny, asBoolean, asChar, asDouble, asFloat, asHRef, asLong, asObjectRef, asRef, asString, asValue, clone, duplicate, stream

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, put, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

_map

protected Map _map

Constructor Detail

MvKeyValueTable

public MvKeyValueTable()

This constructor initializes an empty table.

MvKeyValueTable

public MvKeyValueTable(List orig)

This constructor initializes the MvKeyValueTable instance with orig. The List instance must contain items that implement the List interface. These items should be defined by a key and a value to work properly as key-value tables.

Parameters:

orig - An instance of List containing Lists of two items.

MvKeyValueTable

public MvKeyValueTable(MvKeyValueTable orig)

Copy constructor.

Parameters:

orig - Table to copy.

MvKeyValueTable

public MvKeyValueTable(Map orig)

Copy constructor.

Parameters:

orig - Table to copy.

Method Detail

DeepClone

public static MvKeyValueTable DeepClone(Map map)

size

public int size()

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, it returns Integer.MAX_VALUE.

Specified by:

size in interface Map

Returns:

The number of key-value mappings in this map.

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface Map

Returns:

true if this map contains no key-value mappings.

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface Map

Parameters:

key - The key to be tested.

Returns:

true if this map contains a mapping for the specified key.

Throws:

ClassCastException - if the key is of an inappropriate type for this map.

NullPointerException - if the key is null and this map does not allow null keys.

containsValue

public boolean containsValue(Object value)

Returns true if this map maps one or more keys to the specified value. More specifically, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require a time that is proportional to the size of the map for most implementations of the Map interface.

Specified by:

containsValue in interface Map

Parameters:

value - The value to be tested.

Returns:

true if this map maps one or more keys to the specified value.

get

public Object get(Object key)

Returns the value to which this map maps the specified key. It returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it is also possible that the table explicitly maps the key to null. The containsKey operation may be used to distinguish between these two cases.

Specified by:

get in interface Map

Parameters:

key - The key whose associated value is to be returned.

Returns:

The value to which this map maps the specified key, or null if the map contains no mapping for this key.

Throws:

ClassCastException - if the key is of an inappropriate type for this map.

NullPointerException - if the key is null and this map does not allow null keys.

See Also:

containsKey(Object)

put

public Object put(Object key,
                  Object value)

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for this key, the old value is replaced.

Parameters:

key - The key with which the specified value is to be associated.

value - The value to be associated with the specified key.

Returns:

The previous value associated with the specified key, or null if there was no mapping for the key. A null return value can also indicate that the specified key was previously associated with null, if the implementation supports null values.

Throws:

UnsupportedOperationException - if this map does not support the put operation.

ClassCastException - if the class of the specified key or value prevents it from being stored in this map.

IllegalArgumentException - if some aspects of this key or value prevent it from being stored in this map.

NullPointerException - if this map does not allow null keys or values, and the specified key or value is null.

remove

public Object remove(Object key)

Removes the mapping for this key from the map if one exists (optional operation).

Specified by:

remove in interface Map

Parameters:

key - The key whose mapping is to be removed from the map.

Returns:

The previous value associated with the specified key, or null if there was no mapping for the key. A null return value can also indicate that the specified key was previously associated with null, if the implementation supports null values.

Throws:

UnsupportedOperationException - if this map does not support the remove method.

putAll

public void putAll(Map t)

Copies all the mappings from the specified map to this map (optional operation). These mappings will replace any mappings defined in this map for any of the keys currently in the specified map.

Specified by:

putAll in interface Map

Parameters:

t - The mappings to be stored in this map.

Throws:

UnsupportedOperationException - if this map does not support the putAll method.

ClassCastException - if the class of a key or value in the specified table prevents it from being stored in this map.

IllegalArgumentException - if some aspects of a key or value in the specified map prevent it from being stored in this map.

NullPointerException - if this map does not allow null keys or values, and the specified key or value is null.

clear

public void clear()

Removes all mappings from this map (optional operation).

Specified by:

clear in interface Map

Throws:

UnsupportedOperationException - if this map does not support clear.

keySet

public Set keySet()

Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, through the use of the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

keySet in interface Map

Returns:

A set view of the keys contained in this map.

values

public Collection values()

Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, through the use of the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

values in interface Map

Returns:

A collection view of the values contained in this map.

entrySet

public Set entrySet()

Returns a set view of the mappings contained in this map. Each element in the returned set is a Map.Entry. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, through the use of the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface Map

Returns:

A set view of the mappings contained in this map.

equals

public boolean equals(Object o)

Compares the specified object with this map to check whether they are equal. It returns true if the given object is also a map and the two maps represent the same mappings. More specifically, two maps t1 and t2 represent the same mappings if t1.entrySet().equals(t2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Specified by:

equals in interface Map

Overrides:

equals in class MvUserType

Parameters:

o - Object to be compared with this map.

Returns:

true if the specified object is equal to this map.

hashCode

public int hashCode()

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet view. This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode() for any two maps t1 and t2, as required by the general contract of Object.hashCode.

Specified by:

hashCode in interface Map

Overrides:

hashCode in class Object

Returns:

The hash code value for this map.

See Also:

Map.Entry#hashCode(), Object.hashCode(), Object.equals(Object), equals(Object)

Decode

public static MvKeyValueTable Decode(MvMessage msg)

encode

public MvMessage encode(MvMessage msg)

Writes an instance into an MvMessage for transfer to another process. See the encode method in MvUserType for more details.

Overrides:

encode in class MvUserType

Parameters:

msg - The message to encode.

toMvArray

protected MvArray toMvArray()