gnu.trove.decorator

Class TLongObjectHashMapDecorator

java.lang.Object

java.util.AbstractMap

gnu.trove.decorator.TLongObjectHashMapDecorator

All Implemented Interfaces:

java.util.Map

public class TLongObjectHashMapDecorator
extends java.util.AbstractMap
implements java.util.Map

Wrapper class to make a TLongObjectHashMap conform to the java.util.Map API. This class simply decorates an underlying TLongObjectHashMap 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: TLongObjectHashMapDecorator.java,v 1.1 2002/09/25 05:10:09 ericdf Exp $

Author:

Eric D. Friedman

Nested Class Summary

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

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

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

java.util.Map.Entry<K,V>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
TLongObjectHashMapDecorator(TLongObjectHashMap map) Creates a wrapper that decorates the specified primitive map.

Method Summary

Methods

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

hashCode, keySet, values

Field Detail

_map

protected final TLongObjectHashMap _map

the wrapped primitive map

Constructor Detail

TLongObjectHashMapDecorator

public TLongObjectHashMapDecorator(TLongObjectHashMap map)

Creates a wrapper that decorates the specified primitive map.

Method Detail

put

public java.lang.Object put(java.lang.Object key,
                   java.lang.Object value)

Inserts a key/value pair into the map.

Specified by:

put in interface java.util.Map

Overrides:

put in class java.util.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(java.lang.Object other)

Compares this map with another map for equality of their stored entries.

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.util.AbstractMap

Parameters:

other - an Object value

Returns:

true if the maps are identical

get

public java.lang.Object get(java.lang.Object key)

Retrieves the value for key

Specified by:

get in interface java.util.Map

Overrides:

get in class java.util.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 java.util.Map

Overrides:

clear in class java.util.AbstractMap

remove

public java.lang.Object remove(java.lang.Object key)

Deletes a key/value pair from the map.

Specified by:

remove in interface java.util.Map

Overrides:

remove in class java.util.AbstractMap

Parameters:

key - an Object value

Returns:

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

entrySet

public java.util.Set entrySet()

Returns a Set view on the entries of the map.

Specified by:

entrySet in interface java.util.Map

Specified by:

entrySet in class java.util.AbstractMap

Returns:

a Set value

containsValue

public boolean containsValue(java.lang.Object val)

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

Specified by:

containsValue in interface java.util.Map

Overrides:

containsValue in class java.util.AbstractMap

Parameters:

val - an Object value

Returns:

a boolean value

containsKey

public boolean containsKey(java.lang.Object key)

Checks for the present of key in the keys of the map.

Specified by:

containsKey in interface java.util.Map

Overrides:

containsKey in class java.util.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 java.util.Map

Overrides:

size in class java.util.AbstractMap

Returns:

the map's size.

isEmpty

public boolean isEmpty()

Indicates whether map has any entries.

Specified by:

isEmpty in interface java.util.Map

Overrides:

isEmpty in class java.util.AbstractMap

Returns:

true if the map is empty

putAll

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

Overrides:

putAll in class java.util.AbstractMap

Parameters:

map - a Map value

wrapKey

protected java.lang.Long wrapKey(long k)

Wraps a key

Parameters:

a - key in the underlying map

Returns:

an Object representation of the key

unwrapKey

protected long unwrapKey(java.lang.Object key)

Unwraps a key

Parameters:

a - wrapped key

Returns:

an unwrapped representation of the key

wrapValue

protected final java.lang.Object wrapValue(java.lang.Object o)

Wraps a value

Parameters:

a - value in the underlying map

Returns:

an Object representation of the value

unwrapValue

protected final java.lang.Object unwrapValue(java.lang.Object value)

Unwraps a value

Parameters:

a - wrapped value

Returns:

an unwrapped representation of the value