it.unimi.dsi.fastutil.chars
Class AbstractChar2ReferenceMap<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceFunction<V>
      extended by it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceMap<V>
All Implemented Interfaces:
Char2ReferenceFunction<V>, Char2ReferenceMap<V>, Function<Character,V>, Serializable, Map<Character,V>
Direct Known Subclasses:
AbstractChar2ReferenceSortedMap, Char2ReferenceArrayMap, Char2ReferenceOpenHashMap

public abstract class AbstractChar2ReferenceMap<V>
extends AbstractChar2ReferenceFunction<V>
implements Char2ReferenceMap<V>, Serializable

An abstract class providing basic methods for maps implementing a type-specific interface.

Optional operations just throw an UnsupportedOperationException. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules (they take care of returning null on a missing key).

As a further help, this class provides a BasicEntry inner class that implements a type-specific version of Map.Entry; it is particularly useful for those classes that do not implement their own entries (e.g., most immutable maps).

See Also:
Serialized Form

Nested Class Summary
static class AbstractChar2ReferenceMap.BasicEntry<V>
          This class provides a basic but complete type-specific entry class for all those maps implementations that do not have entries on their own (e.g., most immutable maps).
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2ReferenceMap
Char2ReferenceMap.Entry<V>, Char2ReferenceMap.FastEntrySet<V>
 
Field Summary
static long serialVersionUID
           
 
Method Summary
 boolean containsKey(char k)
          Checks whether the given value is contained in keySet().
 boolean containsValue(Object v)
          Checks whether the given value is contained in values().
 ObjectSet<Map.Entry<Character,V>> entrySet()
          Returns a set view of the mappings contained in this map.
 boolean equals(Object o)
           
 int hashCode()
          Returns a hash code for this map.
 boolean isEmpty()
           
 CharSet keySet()
          Returns a type-specific-set view of the keys of this map.
 void putAll(Map<? extends Character,? extends V> m)
          Puts all pairs in the given map.
 String toString()
           
 ReferenceCollection<V> values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceFunction
clear, containsKey, defaultReturnValue, defaultReturnValue, get, put, put, remove, remove
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ReferenceMap
char2ReferenceEntrySet
 
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ReferenceFunction
defaultReturnValue, defaultReturnValue, get, put, remove
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
clear, containsKey, get, put, remove, size
 
Methods inherited from interface java.util.Map
clear, containsKey, get, put, remove, size
 

Field Detail

serialVersionUID

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

containsValue

public boolean containsValue(Object v)
Checks whether the given value is contained in values().

Specified by:
containsValue in interface Map<Character,V>

containsKey

public boolean containsKey(char k)
Checks whether the given value is contained in keySet().

Specified by:
containsKey in interface Char2ReferenceFunction<V>
See Also:
Function.containsKey(Object)

putAll

public void putAll(Map<? extends Character,? extends V> m)
Puts all pairs in the given map. If the map implements the interface of this map, it uses the faster iterators.

Specified by:
putAll in interface Map<Character,V>
Parameters:
m - a map.

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map<Character,V>

keySet

public CharSet keySet()
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:
keySet in interface Char2ReferenceMap<V>
Specified by:
keySet in interface Map<Character,V>
Returns:
a set view of the keys of this map; it may be safely cast to a type-specific interface.
See Also:
Map.keySet()

values

public ReferenceCollection<V> values()
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:
values in interface Char2ReferenceMap<V>
Specified by:
values in interface Map<Character,V>
Returns:
a set view of the values of this map; it may be safely cast to a type-specific interface.
See Also:
Map.values()

entrySet

public ObjectSet<Map.Entry<Character,V>> entrySet()
Description copied from interface: Char2ReferenceMap
Returns a set view of the mappings contained in this map.

Note that this specification strengthens the one given in Map.entrySet().

Specified by:
entrySet in interface Char2ReferenceMap<V>
Specified by:
entrySet in interface Map<Character,V>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()

hashCode

public int hashCode()
Returns a hash code for this map. The hash code of a map is computed by summing the hash codes of its entries.

Specified by:
hashCode in interface Map<Character,V>
Overrides:
hashCode in class Object
Returns:
a hash code for this map.

equals

public boolean equals(Object o)
Specified by:
equals in interface Map<Character,V>
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object