it.unimi.dsi.fastutil.chars
Class Char2FloatMaps.UnmodifiableMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2FloatFunction
      extended by it.unimi.dsi.fastutil.chars.Char2FloatFunctions.UnmodifiableFunction
          extended by it.unimi.dsi.fastutil.chars.Char2FloatMaps.UnmodifiableMap
All Implemented Interfaces:
Char2FloatFunction, Char2FloatMap, Function<java.lang.Character,java.lang.Float>, java.io.Serializable, java.util.Map<java.lang.Character,java.lang.Float>
Direct Known Subclasses:
Char2FloatSortedMaps.UnmodifiableSortedMap
Enclosing class:
Char2FloatMaps

public static class Char2FloatMaps.UnmodifiableMap
extends Char2FloatFunctions.UnmodifiableFunction
implements Char2FloatMap, java.io.Serializable

An unmodifiable wrapper class for maps.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2FloatMap
Char2FloatMap.Entry, Char2FloatMap.FastEntrySet
 
Method Summary
 ObjectSet<Char2FloatMap.Entry> char2FloatEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(char k)
           
 boolean containsKey(java.lang.Object ok)
          Returns true if this function contains a mapping for the specified key.
 boolean containsValue(float v)
           
 boolean containsValue(java.lang.Object ov)
           
 float defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(float defRetValue)
          Sets the default return value.
 ObjectSet<java.util.Map.Entry<java.lang.Character,java.lang.Float>> entrySet()
          Returns a set view of the mappings contained in this map.
 float get(char k)
          Returns the value to which the given key is mapped.
 boolean isEmpty()
           
 CharSet keySet()
          Returns a set view of the keys contained in this map.
 java.lang.Float put(java.lang.Character k, java.lang.Float v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 float put(char k, float v)
          Adds a pair to the map.
 void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Float> m)
           
 float remove(char k)
          Removes the mapping with the given key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 java.lang.String toString()
           
 FloatCollection values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2FloatFunction
get, remove
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
get, remove
 
Methods inherited from interface java.util.Map
equals, get, hashCode, remove
 

Method Detail

size

public int size()
Description copied from interface: Function
Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:
size in interface Function<java.lang.Character,java.lang.Float>
Specified by:
size in interface java.util.Map<java.lang.Character,java.lang.Float>
Overrides:
size in class Char2FloatFunctions.UnmodifiableFunction
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(char k)
Specified by:
containsKey in interface Char2FloatFunction
Overrides:
containsKey in class Char2FloatFunctions.UnmodifiableFunction
See Also:
Function.containsKey(Object)

containsValue

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

defaultReturnValue

public float defaultReturnValue()
Description copied from interface: Char2FloatFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Char2FloatFunction
Overrides:
defaultReturnValue in class Char2FloatFunctions.UnmodifiableFunction
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(float defRetValue)
Description copied from interface: Char2FloatFunction
Sets the default return value. This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.

Specified by:
defaultReturnValue in interface Char2FloatFunction
Overrides:
defaultReturnValue in class Char2FloatFunctions.UnmodifiableFunction
Parameters:
defRetValue - the new default return value.
See Also:
Char2FloatFunction.defaultReturnValue()

put

public float put(char k,
                 float v)
Description copied from interface: Char2FloatFunction
Adds a pair to the map.

Specified by:
put in interface Char2FloatFunction
Overrides:
put in class Char2FloatFunctions.UnmodifiableFunction
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:
Function.put(Object,Object)

putAll

public void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Float> m)
Specified by:
putAll in interface java.util.Map<java.lang.Character,java.lang.Float>

char2FloatEntrySet

public ObjectSet<Char2FloatMap.Entry> char2FloatEntrySet()
Description copied from interface: Char2FloatMap
Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Char2FloatMap.entrySet() so that it returns an ObjectSet of objects of type Map.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
char2FloatEntrySet in interface Char2FloatMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Char2FloatMap.entrySet()

keySet

public CharSet keySet()
Description copied from interface: Char2FloatMap
Returns a set view of the keys contained in this map.

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

Specified by:
keySet in interface Char2FloatMap
Specified by:
keySet in interface java.util.Map<java.lang.Character,java.lang.Float>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

public FloatCollection values()
Description copied from interface: Char2FloatMap
Returns a set view of the values contained in this map.

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

Specified by:
values in interface Char2FloatMap
Specified by:
values in interface java.util.Map<java.lang.Character,java.lang.Float>
Returns:
a set view of the values contained in this map.
See Also:
Map.values()

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<java.lang.Character,java.lang.Float>
Specified by:
clear in interface java.util.Map<java.lang.Character,java.lang.Float>
Overrides:
clear in class Char2FloatFunctions.UnmodifiableFunction
See Also:
Map.clear()

toString

public java.lang.String toString()
Overrides:
toString in class Char2FloatFunctions.UnmodifiableFunction

put

public java.lang.Float put(java.lang.Character k,
                           java.lang.Float v)
Description copied from class: AbstractChar2FloatFunction
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 Function<java.lang.Character,java.lang.Float>
Specified by:
put in interface java.util.Map<java.lang.Character,java.lang.Float>
Overrides:
put in class AbstractChar2FloatFunction
Parameters:
k - the key.
v - the value.
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.put(Object,Object)

remove

public float remove(char k)
Description copied from interface: Char2FloatFunction
Removes the mapping with the given key.

Specified by:
remove in interface Char2FloatFunction
Overrides:
remove in class Char2FloatFunctions.UnmodifiableFunction
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

get

public float get(char k)
Description copied from interface: Char2FloatFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Char2FloatFunction
Overrides:
get in class Char2FloatFunctions.UnmodifiableFunction
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Function.get(Object)

containsKey

public boolean containsKey(java.lang.Object ok)
Description copied from interface: Function
Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:
containsKey in interface Function<java.lang.Character,java.lang.Float>
Specified by:
containsKey in interface java.util.Map<java.lang.Character,java.lang.Float>
Overrides:
containsKey in class Char2FloatFunctions.UnmodifiableFunction
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object ov)
Specified by:
containsValue in interface java.util.Map<java.lang.Character,java.lang.Float>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Map<java.lang.Character,java.lang.Float>

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Character,java.lang.Float>> entrySet()
Description copied from interface: Char2FloatMap
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 Char2FloatMap
Specified by:
entrySet in interface java.util.Map<java.lang.Character,java.lang.Float>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()