GNU Trove

gnu.trove.decorator
Class TObjectFloatHashMapDecorator

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--gnu.trove.decorator.TObjectFloatHashMapDecorator
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map

public class TObjectFloatHashMapDecorator
extends java.util.AbstractMap
implements java.util.Map, java.lang.Cloneable

Wrapper class to make a TObjectFloatHashMap conform to the java.util.Map API. This class simply decorates an underlying TObjectFloatHashMap 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: TObjectFloatHashMapDecorator.java,v 1.4 2004/03/18 15:30:34 ericdf Exp $
Author:
Eric D. Friedman

Field Summary
protected  TObjectFloatHashMap _map
          the wrapped primitive map
 
Constructor Summary
TObjectFloatHashMapDecorator(TObjectFloatHashMap map)
          Creates a wrapper that decorates the specified primitive map.
 
Method Summary
 void clear()
          Empties the map.
 java.lang.Object clone()
          Clones the underlying trove collection and returns the clone wrapped in a new decorator instance.
 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  java.lang.Object unwrapKey(java.lang.Object key)
          Unwraps a key
protected  float unwrapValue(java.lang.Object value)
          Unwraps a value
protected  java.lang.Object wrapKey(java.lang.Object o)
          Wraps a key
protected  java.lang.Float wrapValue(float k)
          Wraps a value
 
Methods inherited from class java.util.AbstractMap
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 TObjectFloatHashMap _map
the wrapped primitive map

Constructor Detail

TObjectFloatHashMapDecorator

public TObjectFloatHashMapDecorator(TObjectFloatHashMap map)
Creates a wrapper that decorates the specified primitive map.

Method Detail

clone

public java.lang.Object 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 java.util.AbstractMap
Returns:
a copy of the receiver

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 final java.lang.Object wrapKey(java.lang.Object o)
Wraps a key

Returns:
an Object representation of the key

unwrapKey

protected final java.lang.Object unwrapKey(java.lang.Object key)
Unwraps a key

Returns:
an unwrapped representation of the key

wrapValue

protected java.lang.Float wrapValue(float k)
Wraps a value

Returns:
an Object representation of the value

unwrapValue

protected float unwrapValue(java.lang.Object value)
Unwraps a value

Returns:
an unwrapped representation of the value

GNU Trove

GNU Trove is copyright 2001-2003 Eric D. Friedman. All Rights Reserved.