it.unimi.dsi.fastutil.chars
Class Char2BooleanMaps.SynchronizedMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2BooleanFunction
      extended by it.unimi.dsi.fastutil.chars.Char2BooleanFunctions.SynchronizedFunction
          extended by it.unimi.dsi.fastutil.chars.Char2BooleanMaps.SynchronizedMap
All Implemented Interfaces:
Char2BooleanFunction, Char2BooleanMap, Function<Character,Boolean>, Serializable, Map<Character,Boolean>
Direct Known Subclasses:
Char2BooleanSortedMaps.SynchronizedSortedMap
Enclosing class:
Char2BooleanMaps

public static class Char2BooleanMaps.SynchronizedMap
extends Char2BooleanFunctions.SynchronizedFunction
implements Char2BooleanMap, Serializable

A synchronized wrapper class for maps.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2BooleanMap
Char2BooleanMap.Entry, Char2BooleanMap.FastEntrySet
 
Field Summary
static long serialVersionUID
           
 
Method Summary
 ObjectSet<Char2BooleanMap.Entry> char2BooleanEntrySet()
          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(Object ok)
          Returns true if this function contains a mapping for the specified key.
 boolean containsValue(boolean v)
           
 boolean containsValue(Object ov)
           
 boolean defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(boolean defRetValue)
          Sets the default return value.
 ObjectSet<Map.Entry<Character,Boolean>> entrySet()
          Returns a set view of the mappings contained in this map.
 boolean equals(Object o)
           
 boolean get(char k)
          Returns the value to which the given key is mapped.
 int hashCode()
           
 boolean isEmpty()
           
 CharSet keySet()
          Returns a set view of the keys contained in this map.
 Boolean put(Character k, Boolean v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean put(char k, boolean v)
          Adds a pair to the map.
 void putAll(Map<? extends Character,? extends Boolean> m)
           
 boolean 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.
 String toString()
           
 BooleanCollection values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.chars.Char2BooleanFunctions.SynchronizedFunction
get, remove
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
get, remove
 
Methods inherited from interface java.util.Map
get, remove
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
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<Character,Boolean>
Specified by:
size in interface Map<Character,Boolean>
Overrides:
size in class Char2BooleanFunctions.SynchronizedFunction
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 Char2BooleanFunction
Overrides:
containsKey in class Char2BooleanFunctions.SynchronizedFunction
See Also:
Function.containsKey(Object)

containsValue

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

defaultReturnValue

public boolean defaultReturnValue()
Description copied from interface: Char2BooleanFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Char2BooleanFunction
Overrides:
defaultReturnValue in class Char2BooleanFunctions.SynchronizedFunction
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(boolean defRetValue)
Description copied from interface: Char2BooleanFunction
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 Char2BooleanFunction
Overrides:
defaultReturnValue in class Char2BooleanFunctions.SynchronizedFunction
Parameters:
defRetValue - the new default return value.
See Also:
Char2BooleanFunction.defaultReturnValue()

put

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

Specified by:
put in interface Char2BooleanFunction
Overrides:
put in class Char2BooleanFunctions.SynchronizedFunction
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(Map<? extends Character,? extends Boolean> m)
Specified by:
putAll in interface Map<Character,Boolean>

char2BooleanEntrySet

public ObjectSet<Char2BooleanMap.Entry> char2BooleanEntrySet()
Description copied from interface: Char2BooleanMap
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 Char2BooleanMap.entrySet() so that it returns an ObjectSet of objects of type Char2BooleanMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

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

keySet

public CharSet keySet()
Description copied from interface: Char2BooleanMap
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 Char2BooleanMap
Specified by:
keySet in interface Map<Character,Boolean>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

public BooleanCollection values()
Description copied from interface: Char2BooleanMap
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 Char2BooleanMap
Specified by:
values in interface Map<Character,Boolean>
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<Character,Boolean>
Specified by:
clear in interface Map<Character,Boolean>
Overrides:
clear in class Char2BooleanFunctions.SynchronizedFunction
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Char2BooleanFunctions.SynchronizedFunction

put

public Boolean put(Character k,
                   Boolean v)
Description copied from class: AbstractChar2BooleanFunction
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<Character,Boolean>
Specified by:
put in interface Map<Character,Boolean>
Overrides:
put in class Char2BooleanFunctions.SynchronizedFunction
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 boolean remove(char k)
Description copied from interface: Char2BooleanFunction
Removes the mapping with the given key.

Specified by:
remove in interface Char2BooleanFunction
Overrides:
remove in class Char2BooleanFunctions.SynchronizedFunction
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 boolean get(char k)
Description copied from interface: Char2BooleanFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Char2BooleanFunction
Overrides:
get in class Char2BooleanFunctions.SynchronizedFunction
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(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<Character,Boolean>
Specified by:
containsKey in interface Map<Character,Boolean>
Overrides:
containsKey in class Char2BooleanFunctions.SynchronizedFunction
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

containsValue

public boolean containsValue(Object ov)
Specified by:
containsValue in interface Map<Character,Boolean>

isEmpty

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

entrySet

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

hashCode

public int hashCode()
Specified by:
hashCode in interface Map<Character,Boolean>
Overrides:
hashCode in class Object

equals

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