org.apache.commons.collections.map
Class ReferenceIdentityMap

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--org.apache.commons.collections.map.AbstractHashedMap
              |
              +--org.apache.commons.collections.map.AbstractReferenceMap
                    |
                    +--org.apache.commons.collections.map.ReferenceIdentityMap

All Implemented Interfaces:

IterableMap, java.util.Map, java.io.Serializable

public class ReferenceIdentityMap

extends AbstractReferenceMap

implements java.io.Serializable

A Map implementation that allows mappings to be removed by the garbage collector and matches keys and values based on == not equals().

When you construct a ReferenceIdentityMap, you can specify what kind of references are used to store the map's keys and values. If non-hard references are used, then the garbage collector can remove mappings if a key or value becomes unreachable, or if the JVM's memory is running low. For information on how the different reference types behave, see Reference.

Different types of references can be specified for keys and values. The default constructor uses hard keys and soft values, providing a memory-sensitive cache.

This map is similar to ReferenceMap. It differs in that keys and values in this class are compared using ==.

This map will violate the detail of various Map and map view contracts. As a general rule, don't compare this map to other maps.

This Map implementation does not allow null elements. Attempting to add a null key or value to the map will raise a NullPointerException.

This implementation is not synchronized. You can use Collections.synchronizedMap(java.util.Map) to provide synchronized access to a ReferenceIdentityMap. Remember that synchronization will not stop the garbage collecter removing entries.

All the available iterators can be reset back to the start by casting to ResettableIterator and calling reset().

Since:

Commons Collections 3.0 (previously in main package v2.1)

Version:

$Revision: 1.1 $ $Date: 2004/04/27 21:37:32 $

Author:

Stephen Colebourne

See Also:

Reference, Serialized Form

Field Summary

Fields inherited from class org.apache.commons.collections.map.AbstractReferenceMap

HARD, SOFT, WEAK

Constructor Summary

ReferenceIdentityMap()
Constructs a new ReferenceIdentityMap that will use hard references to keys and soft references to values.

ReferenceIdentityMap(int keyType, int valueType)
Constructs a new ReferenceIdentityMap that will use the specified types of references.

ReferenceIdentityMap(int keyType, int valueType, boolean purgeValues)
Constructs a new ReferenceIdentityMap that will use the specified types of references.

ReferenceIdentityMap(int keyType, int valueType, int capacity, float loadFactor)
Constructs a new ReferenceIdentityMap with the specified reference types, load factor and initial capacity.

ReferenceIdentityMap(int keyType, int valueType, int capacity, float loadFactor, boolean purgeValues)
Constructs a new ReferenceIdentityMap with the specified reference types, load factor and initial capacity.

Methods inherited from class org.apache.commons.collections.map.AbstractReferenceMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, mapIterator, put, remove, size, values

Methods inherited from class org.apache.commons.collections.map.AbstractHashedMap

equals, hashCode, putAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReferenceIdentityMap

public ReferenceIdentityMap()

Constructs a new ReferenceIdentityMap that will use hard references to keys and soft references to values.

ReferenceIdentityMap

public ReferenceIdentityMap(int keyType,
                            int valueType)

Constructs a new ReferenceIdentityMap that will use the specified types of references.

Parameters:

keyType - the type of reference to use for keys; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

valueType - the type of reference to use for values; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

ReferenceIdentityMap

public ReferenceIdentityMap(int keyType,
                            int valueType,
                            boolean purgeValues)

Constructs a new ReferenceIdentityMap that will use the specified types of references.

Parameters:

keyType - the type of reference to use for keys; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

valueType - the type of reference to use for values; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

purgeValues - should the value be automatically purged when the key is garbage collected

ReferenceIdentityMap

public ReferenceIdentityMap(int keyType,
                            int valueType,
                            int capacity,
                            float loadFactor)

Constructs a new ReferenceIdentityMap with the specified reference types, load factor and initial capacity.

Parameters:

keyType - the type of reference to use for keys; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

valueType - the type of reference to use for values; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

capacity - the initial capacity for the map

loadFactor - the load factor for the map

ReferenceIdentityMap

public ReferenceIdentityMap(int keyType,
                            int valueType,
                            int capacity,
                            float loadFactor,
                            boolean purgeValues)

Constructs a new ReferenceIdentityMap with the specified reference types, load factor and initial capacity.

Parameters:

keyType - the type of reference to use for keys; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

valueType - the type of reference to use for values; must be AbstractReferenceMap.HARD, AbstractReferenceMap.SOFT, AbstractReferenceMap.WEAK

capacity - the initial capacity for the map

loadFactor - the load factor for the map

purgeValues - should the value be automatically purged when the key is garbage collected