gnu.trove.decorator

Class TDoubleObjectHashMapDecorator

java.lang.Object

java.util.AbstractMap

gnu.trove.decorator.TDoubleObjectHashMapDecorator

All Implemented Interfaces:

Map

public class TDoubleObjectHashMapDecorator
extends AbstractMap
implements Map

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

Since:

trove 0.1.8

Version:

$Id: TDoubleObjectHashMapDecorator.java,v 1.3 2004/11/24 20:00:00 casutton Exp $

Author:

Eric D. Friedman

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected TDoubleObjectHashMap	_map the wrapped primitive map

Constructor Summary

Constructors

Constructor and Description
TDoubleObjectHashMapDecorator(TDoubleObjectHashMap map) Creates a wrapper that decorates the specified primitive map.

Method Summary

Modifier and Type	Method and Description
void	clear() Empties the map.
boolean	containsKey(Object key) Checks for the present of key in the keys of the map.
boolean	containsValue(Object val) Checks for the presence of val in the values of the map.
Set	entrySet() Returns a Set view on the entries of the map.
boolean	equals(Object other) Compares this map with another map for equality of their stored entries.
Object	get(Object key) Retrieves the value for key
boolean	isEmpty() Indicates whether map has any entries.
Object	put(Object key, Object value) Inserts a key/value pair into the map.
void	putAll(Map map) Copies the key/value mappings in map into this map.
Object	remove(Object key) Deletes a key/value pair from the map.
int	size() Returns the number of entries in the map.
protected double	unwrapKey(Object key) Unwraps a key
protected Object	unwrapValue(Object value) Unwraps a value
protected Double	wrapKey(double k) Wraps a key
protected Object	wrapValue(Object o) Wraps a value

Methods inherited from class java.util.AbstractMap

clone, hashCode, keySet, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, hashCode, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, values

Field Detail

_map

protected final TDoubleObjectHashMap _map

the wrapped primitive map

Constructor Detail

TDoubleObjectHashMapDecorator

public TDoubleObjectHashMapDecorator(TDoubleObjectHashMap map)

Creates a wrapper that decorates the specified primitive map.

Method Detail

put

public Object put(Object key,
                  Object value)

Inserts a key/value pair into the map.

Specified by:

put in interface Map

Overrides:

put in class AbstractMap

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

Overrides:

equals in class AbstractMap

Parameters:

other - an Object value

Returns:

true if the maps are identical

get

public Object get(Object key)

Retrieves the value for key

Specified by:

get in interface Map

Overrides:

get in class AbstractMap

Parameters:

key - an Object value

Returns:

the value of key or null if no such mapping exists.

clear

public void clear()

Empties the map.

Specified by:

clear in interface Map

Overrides:

clear in class AbstractMap

remove

public Object remove(Object key)

Deletes a key/value pair from the map.

Specified by:

remove in interface Map

Overrides:

remove in class AbstractMap

Parameters:

key - an Object value

Returns:

the removed value, or Integer(0) if it was not found in the map

entrySet

public Set entrySet()

Returns a Set view on the entries of the map.

Specified by:

entrySet in interface Map

Specified by:

entrySet in class AbstractMap

Returns:

a Set value

containsValue

public boolean containsValue(Object val)

Checks for the presence of val in the values of the map.

Specified by:

containsValue in interface Map

Overrides:

containsValue in class AbstractMap

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

Overrides:

containsKey in class AbstractMap

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

Overrides:

size in class AbstractMap

Returns:

the map's size.

isEmpty

public boolean isEmpty()

Indicates whether map has any entries.

Specified by:

isEmpty in interface Map

Overrides:

isEmpty in class AbstractMap

Returns:

true if the map is empty

putAll

public void putAll(Map 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

Overrides:

putAll in class AbstractMap

Parameters:

map - a Map value

wrapKey

protected Double wrapKey(double k)

Wraps a key

Parameters:

a - key in the underlying map

Returns:

an Object representation of the key

unwrapKey

protected double unwrapKey(Object key)

Unwraps a key

Parameters:

a - wrapped key

Returns:

an unwrapped representation of the key

wrapValue

protected final Object wrapValue(Object o)

Wraps a value

Parameters:

a - value in the underlying map

Returns:

an Object representation of the value

unwrapValue

protected final Object unwrapValue(Object value)

Unwraps a value

Parameters:

a - wrapped value

Returns:

an unwrapped representation of the value