gnu.trove.decorator

Class TLongObjectMapDecorator<V>

  • All Implemented Interfaces:
    Externalizable, Serializable, Cloneable, Map<Long,V> 

    public class TLongObjectMapDecorator<V>
extends AbstractMap<Long,V>
implements Map<Long,V>, Externalizable, Cloneable
    Wrapper class to make a TLongObjectMap conform to the java.util.Map API. This class simply decorates an underlying TLongObjectMap 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
    See Also:
    Serialized Form

    • Constructor Detail

      • TLongObjectMapDecorator

        public TLongObjectMapDecorator()
        FOR EXTERNALIZATION ONLY!!

      • TLongObjectMapDecorator

        public TLongObjectMapDecorator(TLongObjectMap<V> map)
        Creates a wrapper that decorates the specified primitive map.
        Parameters:
        map - the TLongObjectMap to wrap.

    • Method Detail

      • getMap

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

      • put

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

      • get

        public V get(Object key)
        Retrieves the value for key
        Specified by:
        get in interface  Map<Long,V>
        Overrides:
        get in class  AbstractMap<Long,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<Long,V>
        Overrides:
        remove in class  AbstractMap<Long,V>
        Parameters:
        key - an Object value
        Returns:
        the removed value, or Integer(0) if it was not found in the map

      • containsValue

        public boolean containsValue(Object val)
        Checks for the presence of val in the values of the map.
        Specified by:
        containsValue in interface  Map<Long,V>
        Overrides:
        containsValue in class  AbstractMap<Long,V>
        Parameters:
        val - an Object value
        Returns:
        a boolean value

      • containsKey

        public boolean containsKey(Object key)
        Checks for the present of key in the keys of the map.
        Specified by:
        containsKey in interface  Map<Long,V>
        Overrides:
        containsKey in class  AbstractMap<Long,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<Long,V>
        Overrides:
        size in class  AbstractMap<Long,V>
        Returns:
        the map's size.

      • isEmpty

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

      • putAll

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

      • wrapKey

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

      • unwrapKey

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