IlpAbstractValueMap (Rogue Wave JViews 9.0 API)

java.lang.Object
- ilog.cpl.util.IlpAbstractValueMap

All Implemented Interfaces:

IlpValueMap, Map

Direct Known Subclasses:

IlpIndexedValueMap, IlpOrderedValueMap
```
public abstract class IlpAbstractValueMap
extends Object
implements IlpValueMap
```
This class models a simple value map implementation, which associates typed keys with typed values.
The keys and values set to this value map are subject to type conversion, which is done using the default type converter or a type converter defined using the method setTypeConverter.
Compatibility Note: In JViews 8.0, this class was moved from ilog.cpl.service to ilog.cpl.util.

Since:

JViews 8.0

See Also:

IlpValueMapFunction

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Modifier Constructor and Description

protected IlpAbstractValueMap()
Default constructor

Constructors
Modifier	Constructor and Description
`protected`	`IlpAbstractValueMap()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addValue(Object key, Object value)` Adds a new key-value pair.
`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.
`Set`	`entrySet()` Returns a set view of the mappings contained in this map.
`boolean`	`equals(Object o)` Compares the specified object with this map for equality.
`Object`	`get(Object key)` Returns the value to which this map maps the specified key.
`Class`	`getKeyClass()` Returns the Java type of the keys used in this value map.
`Object[]`	`getKeys()` Returns the keys present in the value map
`Object`	`getKeys(int index)` Returns the key present in the value map at the given index.
`protected IlpTypeConverter`	`getTypeConverter()` Returns the type converter used to convert the received value to the expected value.
`Object`	`getValue(Object key)` Returns the mapped value associated with a key.
`Class`	`getValueClass()` Returns the Java type of the values returned by this value map.
`Object[]`	`getValues()` Returns the values present in the value map
`Object`	`getValues(int i)` Returns the value present in the value map at the given index.
`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 of the mappings from the specified map to this map.
`Object`	`remove(Object key)` Removes the mapping for this key from this map if present.
`void`	`setKeyClass(Class k)` Sets the Java type of the keys used in this value map.
`void`	`setTypeConverter(IlpTypeConverter t)` Sets the type converter used to convert the received value to the expected value.
`void`	`setValueClass(Class k)` Sets the Java type of the values returned by this value map.
`int`	`size()` Returns the number of key-value mappings in this map.
`Collection`	`values()` Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - IlpAbstractValueMap
```
protected IlpAbstractValueMap()
```
    Default constructor
- Method Detail
  - setTypeConverter
```
public void setTypeConverter(IlpTypeConverter t)
```
    Sets the type converter used to convert the received value to the expected value.
    
    Parameters:
    
    t - Type converter used to convert values set in the value to the type expected.
    
    See Also:
    
    IlpTypeConverter
  - getTypeConverter
```
protected IlpTypeConverter getTypeConverter()
```
    Returns the type converter used to convert the received value to the expected value.
  - setKeyClass
```
public void setKeyClass(Class k)
```
    Sets the Java type of the keys used in this value map.
  - getKeyClass
```
public Class getKeyClass()
```
    Returns the Java type of the keys used in this value map.
    
    Specified by:
    
    getKeyClass in interface IlpValueMap
    
    Returns:
    
    Java type of value map keys.
  - setValueClass
```
public void setValueClass(Class k)
```
    Sets the Java type of the values returned by this value map.
  - getValueClass
```
public Class getValueClass()
```
    Returns the Java type of the values returned by this value map.
    
    Specified by:
    
    getValueClass in interface IlpValueMap
    
    Returns:
    
    Java type of returned values.
  - getKeys
```
public Object[] getKeys()
```
    Returns the keys present in the value map
    
    Returns:
    
    Java type of returned values.
  - getKeys
```
public Object getKeys(int index)
               throws ArrayIndexOutOfBoundsException
```
    Returns the key present in the value map at the given index.
    
    Parameters:
    
    index - Index of the property to be retrieved.
    
    Returns:
    
    Key that is defined at the given index
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - getValues
```
public Object[] getValues()
```
    Returns the values present in the value map
    
    Returns:
    
    Java type of returned values.
  - getValues
```
public Object getValues(int i)
                 throws ArrayIndexOutOfBoundsException
```
    Returns the value present in the value map at the given index.
    
    Parameters:
    
    i - Index of the property to be retrieved.
    
    Returns:
    
    Key that is defined at the given index
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - getValue
```
public Object getValue(Object key)
```
    Returns the mapped value associated with a key.
    
    Specified by:
    
    getValue in interface IlpValueMap
    
    Parameters:
    
    key - The key associated with the value to retrieve.
    
    Returns:
    
    Value associated with the key.
  - addValue
```
public boolean addValue(Object key,
                        Object value)
```
    Adds a new key-value pair.
    
    Specified by:
    
    addValue in interface IlpValueMap
    
    Parameters:
    
    key - The key for the key-value pair.
    
    value - The value to be added.
  - size
```
public int size()
```
    Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, 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 - key whose presence in this map is 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 not permit null keys.
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value. More formally, 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 time linear in the map size for most implementations of the Map interface.
    
    Specified by:
    
    containsValue in interface Map
    
    Parameters:
    
    value - value whose presence in this map is 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. 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's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
    
    Specified by:
    
    get in interface Map
    
    Parameters:
    
    key - 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 - key is null and this map does not not permit 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.
    
    Specified by:
    
    put in interface Map
    
    Parameters:
    
    key - key with which the specified value is to be associated.
    
    value - value to be associated with the specified key.
    
    Returns:
    
    previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map.
    
    ClassCastException - if the class of the specified key or value prevents it from being stored in this map.
    
    IllegalArgumentException - if some aspect of this key or value prevents it from being stored in this map.
    
    NullPointerException - this map does not permit 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 this map if present.
    
    Specified by:
    
    remove in interface Map
    
    Parameters:
    
    key - key whose mapping is to be removed from the map.
    
    Returns:
    
    previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.
  - putAll
```
public void putAll(Map t)
```
    Copies all of the mappings from the specified map to this map. These mappings will replace any mappings that this map had for any of the keys currently in the specified map.
    
    Specified by:
    
    putAll in interface Map
    
    Parameters:
    
    t - Mappings to be stored in this map.
  - clear
```
public void clear()
```
    Removes all mappings from this map (optional operation).
    
    Specified by:
    
    clear in interface Map
  - 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, via 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, via 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, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    This operation is not supported.
    
    Specified by:
    
    entrySet in interface Map
    
    Returns:
    
    a set view of the mappings contained in this map.
    
    Throws:
    
    UnsupportedOperationException
  - equals
```
public boolean equals(Object o)
```
    Compares the specified object with this map for equality. Returns true if the given object is also a map and the two Maps represent the same mappings. More formally, 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 Object
    
    Parameters:
    
    o - object to be compared for equality 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 hashCodes 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)

Class IlpAbstractValueMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

IlpAbstractValueMap

Method Detail

setTypeConverter

getTypeConverter

setKeyClass

getKeyClass

setValueClass

getValueClass

getKeys

getKeys

getValues

getValues

getValue

addValue

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode