it.unimi.dsi.fastutil.objects
Class Object2CharRBTreeMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.objects.AbstractObject2CharMap
      extended byit.unimi.dsi.fastutil.objects.AbstractObject2CharSortedMap
          extended byit.unimi.dsi.fastutil.objects.Object2CharRBTreeMap
All Implemented Interfaces:
Cloneable, Map, Object2CharMap, Object2CharSortedMap, Serializable, SortedMap

public class Object2CharRBTreeMap
extends AbstractObject2CharSortedMap
implements Serializable, Cloneable, Object2CharSortedMap

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

Nested Class Summary
 
Nested classes inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2CharMap
AbstractObject2CharMap.BasicEntry
 
Field Summary
static long serialVersionUID
           
 
Constructor Summary
Object2CharRBTreeMap()
          Creates a new empty tree map.
Object2CharRBTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Object2CharRBTreeMap(Map m)
          Creates a new tree map copying a given map.
Object2CharRBTreeMap(Object2CharMap m)
          Creates a new tree map copying a given map.
Object2CharRBTreeMap(Object2CharSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Object2CharRBTreeMap(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)
          Checks whether the given value is contained in keySet().
 boolean containsValue(char v)
          Checks whether the given value is contained in values().
 Set entrySet()
           
 Object firstKey()
          Delegates to the corresponding type-specific method.
 Object get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 char getChar(Object k)
          Returns the value to which the given key is mapped.
 SortedMap headMap(Object to)
          Delegates to the corresponding type-specific method.
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 Object lastKey()
          Delegates to the corresponding type-specific method.
 char put(Object k, char v)
          Adds a pair to the map.
 Object put(Object ok, Object ov)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 Object remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 char removeChar(Object k)
          Removes the mapping with the given key.
 int size()
           
 SortedMap subMap(Object from, Object to)
          Delegates to the corresponding type-specific method.
 SortedMap tailMap(Object from)
          Delegates to the corresponding type-specific method.
 Collection values()
          Returns a type-specific collection view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2CharMap
containsValue, 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.Object2CharMap
defaultReturnValue, defaultReturnValue, getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
containsValue, equals, hashCode, putAll
 

Field Detail

serialVersionUID

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

Object2CharRBTreeMap

public Object2CharRBTreeMap()
Creates a new empty tree map.


Object2CharRBTreeMap

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

Parameters:
c - a Comparator.

Object2CharRBTreeMap

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

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

Object2CharRBTreeMap

public Object2CharRBTreeMap(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.

Object2CharRBTreeMap

public Object2CharRBTreeMap(Object2CharMap m)
Creates a new tree map copying a given map.

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

Object2CharRBTreeMap

public Object2CharRBTreeMap(Object2CharSortedMap 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 char put(Object k,
                      char v)
Description copied from interface: Object2CharMap
Adds a pair to the map.

Specified by:
put in interface Object2CharMap
Overrides:
put in class AbstractObject2CharMap

removeChar

public final char removeChar(Object k)
Description copied from interface: Object2CharMap
Removes the mapping with the given key.

Specified by:
removeChar in interface Object2CharMap
Overrides:
removeChar in class AbstractObject2CharMap

put

public Object put(Object ok,
                  Object ov)
Description copied from class: AbstractObject2CharMap
Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:
put in interface Map
Overrides:
put in class AbstractObject2CharMap

remove

public Object remove(Object ok)
Description copied from class: AbstractObject2CharMap
Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:
remove in interface Map
Overrides:
remove in class AbstractObject2CharMap

containsValue

public boolean containsValue(char v)
Description copied from class: AbstractObject2CharMap
Checks whether the given value is contained in AbstractObject2CharMap.values().

Specified by:
containsValue in interface Object2CharMap
Overrides:
containsValue in class AbstractObject2CharMap

clear

public void clear()
Specified by:
clear in interface Map
Overrides:
clear in class AbstractObject2CharMap

containsKey

public boolean containsKey(Object k)
Description copied from class: AbstractObject2CharMap
Checks whether the given value is contained in AbstractObject2CharMap.keySet().

Specified by:
containsKey in interface Map
Overrides:
containsKey in class AbstractObject2CharMap

size

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

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map
Overrides:
isEmpty in class AbstractObject2CharMap

getChar

public char getChar(Object k)
Description copied from interface: Object2CharMap
Returns the value to which the given key is mapped.

Specified by:
getChar in interface Object2CharMap
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Map.get(Object)

get

public Object get(Object ok)
Description copied from class: AbstractObject2CharMap
Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:
get in interface Map
Overrides:
get in class AbstractObject2CharMap

firstKey

public Object firstKey()
Description copied from class: AbstractObject2CharSortedMap
Delegates to the corresponding type-specific method.

Specified by:
firstKey in interface SortedMap
Overrides:
firstKey in class AbstractObject2CharSortedMap

lastKey

public Object lastKey()
Description copied from class: AbstractObject2CharSortedMap
Delegates to the corresponding type-specific method.

Specified by:
lastKey in interface SortedMap
Overrides:
lastKey in class AbstractObject2CharSortedMap

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
Overrides:
keySet in class AbstractObject2CharSortedMap
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
Overrides:
values in class AbstractObject2CharMap
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)
Description copied from class: AbstractObject2CharSortedMap
Delegates to the corresponding type-specific method.

Specified by:
headMap in interface SortedMap
Overrides:
headMap in class AbstractObject2CharSortedMap

tailMap

public SortedMap tailMap(Object from)
Description copied from class: AbstractObject2CharSortedMap
Delegates to the corresponding type-specific method.

Specified by:
tailMap in interface SortedMap
Overrides:
tailMap in class AbstractObject2CharSortedMap

subMap

public SortedMap subMap(Object from,
                        Object to)
Description copied from class: AbstractObject2CharSortedMap
Delegates to the corresponding type-specific method.

Specified by:
subMap in interface SortedMap
Overrides:
subMap in class AbstractObject2CharSortedMap

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.