gnu.trove.decorator

Class TIntDoubleHashMapDecorator

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

    public class TIntDoubleHashMapDecorator
extends AbstractMap<Integer,Double>
implements Map<Integer,Double>, Cloneable
    Wrapper class to make a TIntDoubleHashMap conform to the java.util.Map API. This class simply decorates an underlying TIntDoubleHashMap 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

      • TIntDoubleHashMapDecorator

        public TIntDoubleHashMapDecorator(TIntDoubleHashMap map)
        Creates a wrapper that decorates the specified primitive map.

    • Method Detail

      • getMap

        public TIntDoubleHashMap getMap()
        Returns a reference to the map wrapped by this decorator.

      • clone

        public TIntDoubleHashMapDecorator 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<Integer,Double>
        Returns:
        a copy of the receiver

      • put

        public Double put(Integer key,
                  Double value)
        Inserts a key/value pair into the map.
        Specified by:
        put in interface  Map<Integer,Double>
        Overrides:
        put in class  AbstractMap<Integer,Double>
        Parameters:
        key - an Object value
        value - an Object value
        Returns:
        the previous value associated with key, or Double(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<Integer,Double>
        Overrides:
        equals in class  AbstractMap<Integer,Double>
        Parameters:
        other - an Object value
        Returns:
        true if the maps are identical

      • get

        public Double get(Integer key)
        Retrieves the value for key
        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 Double remove(Integer key)
        Deletes a key/value pair from the map.
        Parameters:
        key - an Object value
        Returns:
        the removed value, or Double(0) if it was not found in the map

      • putAll

        public void putAll(Map<? extends Integer,? extends Double> 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<Integer,Double>
        Overrides:
        putAll in class  AbstractMap<Integer,Double>
        Parameters:
        map - a Map value

      • wrapKey

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

      • unwrapKey

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

      • wrapValue

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

      • unwrapValue

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