it.unimi.dsi.fastutil.objects
Class Object2CharAVLTreeMap

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

public class Object2CharAVLTreeMap
extends AbstractObject2CharMap
implements Serializable, Cloneable, Object2CharSortedMap

A type-specific AVL 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
Object2CharAVLTreeMap()
          Creates a new empty tree map.
Object2CharAVLTreeMap(Comparator c)
          Creates a new empty tree map with the given comparator.
Object2CharAVLTreeMap(Map m)
          Creates a new tree map copying a given map.
Object2CharAVLTreeMap(Object2CharMap m)
          Creates a new tree map copying a given map.
Object2CharAVLTreeMap(Object2CharSortedMap m)
          Creates a new tree map copying a given sorted map (and its Comparator).
Object2CharAVLTreeMap(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(char v)
           
 Set entrySet()
           
 Object firstKey()
           
 Object get(Object ok)
           
 char getChar(Object k)
          Returns the value to which the given key is mapped.
 SortedMap headMap(Object to)
           
 boolean isEmpty()
           
 Set keySet()
          Returns a type-specific sorted set view of the keys contained in this map.
 Object lastKey()
           
 char put(Object k, char v)
          Adds a pair to the map.
 Object put(Object ok, Object ov)
           
 Object remove(Object ok)
           
 char removeChar(Object k)
          Removes the mapping with the given key.
 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.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

Object2CharAVLTreeMap

public Object2CharAVLTreeMap()
Creates a new empty tree map.


Object2CharAVLTreeMap

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


Object2CharAVLTreeMap

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

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

Object2CharAVLTreeMap

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

Object2CharAVLTreeMap

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

Object2CharAVLTreeMap

public Object2CharAVLTreeMap(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
Parameters:
k - the key.
v - the value.
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Map.put(Object,Object)

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
Parameters:
k -
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Map.remove(Object)

put

public Object put(Object ok,
                  Object ov)
Specified by:
put in interface Map

remove

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

containsValue

public boolean containsValue(char v)
Specified by:
containsValue in interface Object2CharMap
See Also:
Map.containsValue(Object)

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

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)

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.