gnu.trove.decorator

Class TDoubleObjectHashMapDecorator<V>

  • All Implemented Interfaces:
    Cloneable, Map<Double,V> 

    public class TDoubleObjectHashMapDecorator<V>
extends AbstractMap<Double,V>
implements Map<Double,V>, Cloneable
    Wrapper class to make a TDoubleObjectHashMap conform to the java.util.Map API. This class simply decorates an underlying TDoubleObjectHashMap and translates the Object-based APIs into their Trove primitive analogs.

    Note that wrapping and unwrapping primitive values is extremely inefficient. If possible, users of this class should override the appropriate methods in this class and use a table of canonical values.

    Created: Mon Sep 23 22:07:40 PDT 2002

    • Constructor Detail

      • TDoubleObjectHashMapDecorator

        public TDoubleObjectHashMapDecorator(TDoubleObjectHashMap<V> map)
        Creates a wrapper that decorates the specified primitive map.

    • Method Detail

      • getMap

        public TDoubleObjectHashMap<V> getMap()
        Returns a reference to the map wrapped by this decorator.

      • clone

        public TDoubleObjectHashMapDecorator clone()
        Clones the underlying trove collection and returns the clone wrapped in a new decorator instance. This is a shallow clone except where primitives are concerned.
        Overrides:
        clone in class  AbstractMap<Double,V>
        Returns:
        a copy of the receiver

      • put

        public V put(Double key,
             V value)
        Inserts a key/value pair into the map.
        Specified by:
        put in interface  Map<Double,V>
        Overrides:
        put in class  AbstractMap<Double,V>
        Parameters:
        key - an Object value
        value - an Object value
        Returns:
        the previous value associated with key, or Integer(0) if none was found.

      • equals

        public boolean equals(Object other)
        Compares this map with another map for equality of their stored entries.
        Specified by:
        equals in interface  Map<Double,V>
        Overrides:
        equals in class  AbstractMap<Double,V>
        Parameters:
        other - an Object value
        Returns:
        true if the maps are identical

      • get

        public V get(Object key)
        Retrieves the value for key
        Specified by:
        get in interface  Map<Double,V>
        Overrides:
        get in class  AbstractMap<Double,V>
        Parameters:
        key - an Object value
        Returns:
        the value of key or null if no such mapping exists.

      • clear

        public void clear()
        Empties the map.

      • remove

        public V remove(Object key)
        Deletes a key/value pair from the map.
        Specified by:
        remove in interface  Map<Double,V>
        Overrides:
        remove in class  AbstractMap<Double,V>
        Parameters:
        key - an Object value
        Returns:
        the removed value, or Integer(0) if it was not found in the map

      • containsKey

        public boolean containsKey(Object key)
        Checks for the present of key in the keys of the map.
        Specified by:
        containsKey in interface  Map<Double,V>
        Overrides:
        containsKey in class  AbstractMap<Double,V>
        Parameters:
        key - an Object value
        Returns:
        a boolean value

      • size

        public int size()
        Returns the number of entries in the map.
        Specified by:
        size in interface  Map<Double,V>
        Overrides:
        size in class  AbstractMap<Double,V>
        Returns:
        the map's size.

      • isEmpty

        public boolean isEmpty()
        Indicates whether map has any entries.
        Specified by:
        isEmpty in interface  Map<Double,V>
        Overrides:
        isEmpty in class  AbstractMap<Double,V>
        Returns:
        true if the map is empty

      • putAll

        public void putAll(Map<? extends Double,? extends V> map)
        Copies the key/value mappings in map into this map. Note that this will be a deep copy, as storage is by primitive value.
        Specified by:
        putAll in interface  Map<Double,V>
        Overrides:
        putAll in class  AbstractMap<Double,V>
        Parameters:
        map - a Map value

      • wrapKey

        protected Double wrapKey(double k)
        Wraps a key
        Parameters:
        k - key in the underlying map
        Returns:
        an Object representation of the key

      • unwrapKey

        protected double unwrapKey(Object key)
        Unwraps a key
        Parameters:
        key - wrapped key
        Returns:
        an unwrapped representation of the key

      • wrapValue

        protected final V wrapValue(V o)
        Wraps a value
        Parameters:
        o - value in the underlying map
        Returns:
        an Object representation of the value

      • unwrapValue

        protected final V unwrapValue(V value)
        Unwraps a value
        Parameters:
        value - wrapped value
        Returns:
        an unwrapped representation of the value