it.unimi.dsi.fastutil.objects
Class Object2ObjectRBTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.objects.AbstractObject2ObjectMap
      extended byit.unimi.dsi.fastutil.objects.Object2ObjectRBTreeMap
All Implemented Interfaces:
Cloneable, Map, Object2ObjectMap, Object2ObjectSortedMap, Serializable, SortedMap

public class Object2ObjectRBTreeMap
extends AbstractObject2ObjectMap
implements Serializable, Cloneable, Object2ObjectSortedMap

A type-specific red-black tree map with a fast, small-footprint implementation.

The iterators provided by the views of this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
Object2ObjectRBTreeMap()
          Creates a new empty tree map.
Object2ObjectRBTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Object2ObjectRBTreeMap(Map m)
          Creates a new tree map copying a given map.
Object2ObjectRBTreeMap(Object2ObjectMap m)
          Creates a new tree map copying a given map.
Object2ObjectRBTreeMap(Object2ObjectSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Object2ObjectRBTreeMap(SortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
 
Method Summary
 void clear()
           
 Object clone()
          Returns a deep copy of this tree map.
 Comparator comparator()
           
 boolean containsKey(Object k)
           
 boolean containsValue(Object v)
           
 Set entrySet()
           
 Object firstKey()
           
 Object get(Object ok)
           
 SortedMap headMap(Object to)
           
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 Object lastKey()
           
 Object put(Object k, Object v)
           
 Object remove(Object k)
           
 int size()
           
 SortedMap subMap(Object from, Object to)
           
 SortedMap tailMap(Object from)
           
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ObjectMap
defaultReturnValue, defaultReturnValue, equals, getDefRetValue, hashCode, putAll, setDefRetValue, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ObjectMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
equals, hashCode, putAll
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap()
Creates a new empty tree map.


Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(Comparator c)
Creates a new empty tree map with the given comparator.


Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(Map m)
Creates a new tree map copying a given map.

Parameters:
m - a Map to be copied into the new tree map.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(SortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:
m - a SortedMap to be copied into the new tree map.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(Object2ObjectMap m)
Creates a new tree map copying a given map.

Parameters:
m - a type-specific map to be copied into the new tree map.

Object2ObjectRBTreeMap

public Object2ObjectRBTreeMap(Object2ObjectSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:
m - a type-specific sorted map to be copied into the new tree map.
Method Detail

put

public final Object put(Object k,
                        Object v)
Specified by:
put in interface Map

remove

public final Object remove(Object k)
Specified by:
remove in interface Map

containsValue

public boolean containsValue(Object v)
Specified by:
containsValue in interface Map

clear

public void clear()
Specified by:
clear in interface Map

containsKey

public boolean containsKey(Object k)
Specified by:
containsKey in interface Map

size

public int size()
Specified by:
size in interface Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map

get

public Object get(Object ok)
Specified by:
get in interface Map

firstKey

public Object firstKey()
Specified by:
firstKey in interface SortedMap

lastKey

public Object lastKey()
Specified by:
lastKey in interface SortedMap

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

keySet

public Set keySet()
Returns a type-specific sorted set view of the keys contained in this map.

In addition to the semantics of Map.keySet(), you can safely cast the set returned by this call to a type-specific sorted set interface.

Specified by:
keySet in interface Map
Returns:
a type-specific sorted set view of the keys contained in this map.

values

public Collection values()
Returns a type-specific collection view of the values contained in this map.

In addition to the semantics of Map.values(), you can safely cast the collection returned by this call to a type-specific collection interface.

Specified by:
values in interface Map
Returns:
a type-specific collection view of the values contained in this map.

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedMap

headMap

public SortedMap headMap(Object to)
Specified by:
headMap in interface SortedMap

tailMap

public SortedMap tailMap(Object from)
Specified by:
tailMap in interface SortedMap

subMap

public SortedMap subMap(Object from,
                        Object to)
Specified by:
subMap in interface SortedMap

clone

public Object clone()
Returns a deep copy of this tree map.

This method performs a deep copy of this tree map; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Returns:
a deep copy of this tree map.