ilog.cpl.util
Interface IlpValueMap

All Superinterfaces:

Map

All Known Implementing Classes:

IlpAbstractValueMap, IlpDefaultValueMap, IlpIndexedValueMap, IlpOrderedValueMap

public interface IlpValueMap
extends Map

This interface extends the Map interface to create a named value map associating specifically typed keys with specifically typed values. In addition to enforcing type restrictions, the type information can be used to filter value maps based on specific Java types. For instance, you can get a list of value maps for Integer values returning an Icon.

Compatibility Note: In JViews 8.0, this class was moved from ilog.cpl.service to ilog.cpl.util.

Since:

JViews 8.0

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

boolean	addValue(Object key, Object value) Adds a new key-value pair.
Class	getKeyClass() Returns the Java type of the keys used in this value map.
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.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getKeyClass

Class getKeyClass()

Returns the Java type of the keys used in this value map.

Returns:

Java type of value map keys.

getValueClass

Class getValueClass()

Returns the Java type of the values returned by this value map.

Returns:

Java type of returned values.

getValue

Object getValue(Object key)

Returns the mapped value associated with a key.

Parameters:

key - The key associated with the value to retrieve.

Returns:

Value associated with the key.

addValue

boolean addValue(Object key,
                 Object value)

Adds a new key-value pair.

Parameters:

key - The key for the key-value pair.

value - The value to be added.