it.unimi.dsi.fastutil.objects
Class Object2BooleanMaps.UnmodifiableMap

java.lang.Object
  extended byit.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap
      extended byit.unimi.dsi.fastutil.objects.Object2BooleanMaps.UnmodifiableMap
All Implemented Interfaces:
Map, Object2BooleanMap, Serializable
Direct Known Subclasses:
Object2BooleanSortedMaps.UnmodifiableSortedMap
Enclosing class:
Object2BooleanMaps

public static class Object2BooleanMaps.UnmodifiableMap
extends AbstractObject2BooleanMap
implements Object2BooleanMap, Serializable

An unmodifiable wrapper class for maps.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap
AbstractObject2BooleanMap.BasicEntry
 
Nested classes inherited from class it.unimi.dsi.fastutil.objects.Object2BooleanMap
Object2BooleanMap.Entry
 
Field Summary
static long serialVersionUID
           
 
Method Summary
 void clear()
           
 boolean containsKey(Object k)
          Checks whether the given value is contained in keySet().
 boolean containsValue(boolean v)
          Checks whether the given value is contained in values().
 boolean containsValue(Object ov)
           
 boolean defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(boolean defRetValue)
          Sets the default return value.
 Set entrySet()
           
 Object get(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean getBoolean(Object k)
          Returns the value to which the given key is mapped.
 Set keySet()
          Returns a type-specific-set view of the keys of this map.
 boolean put(Object k, boolean v)
          Adds a pair to the map.
 Object put(Object k, Object v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 void putAll(Map m)
          Puts all pairs in the given map.
 void putAll(Object2BooleanMap c)
           
 Object remove(Object ok)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean removeBoolean(Object k)
          Removes the mapping with the given key.
 int size()
           
 String toString()
           
 Collection values()
          Returns a type-specific-set view of the values of this map.
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap
equals, getDefRetValue, hashCode, isEmpty, setDefRetValue
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2BooleanMap
getDefRetValue, setDefRetValue
 
Methods inherited from interface java.util.Map
equals, hashCode, isEmpty
 

Field Detail

serialVersionUID

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

remove

public Object remove(Object ok)
Description copied from class: AbstractObject2BooleanMap
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 AbstractObject2BooleanMap

get

public Object get(Object ok)
Description copied from class: AbstractObject2BooleanMap
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 AbstractObject2BooleanMap

size

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

containsKey

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

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

containsValue

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

Specified by:
containsValue in interface Object2BooleanMap
Overrides:
containsValue in class AbstractObject2BooleanMap

defaultReturnValue

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

Specified by:
defaultReturnValue in interface Object2BooleanMap
Overrides:
defaultReturnValue in class AbstractObject2BooleanMap

defaultReturnValue

public void defaultReturnValue(boolean defRetValue)
Description copied from interface: Object2BooleanMap
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 Object2BooleanMap
Overrides:
defaultReturnValue in class AbstractObject2BooleanMap

put

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

Specified by:
put in interface Object2BooleanMap
Overrides:
put in class AbstractObject2BooleanMap

putAll

public void putAll(Object2BooleanMap c)

putAll

public void putAll(Map m)
Description copied from class: AbstractObject2BooleanMap
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
Overrides:
putAll in class AbstractObject2BooleanMap
Parameters:
m - a map.

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

keySet

public Set keySet()
Description copied from class: AbstractObject2BooleanMap
Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by Map.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 Map
Overrides:
keySet in class AbstractObject2BooleanMap
Returns:
a set view of the keys of this map; it may be safely cast to a type-specific interface.

values

public Collection values()
Description copied from class: AbstractObject2BooleanMap
Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by Map.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 Map
Overrides:
values in class AbstractObject2BooleanMap
Returns:
a set view of the values of this map; it may be safely cast to a type-specific interface.

clear

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

toString

public String toString()
Overrides:
toString in class AbstractObject2BooleanMap

put

public Object put(Object k,
                  Object v)
Description copied from class: AbstractObject2BooleanMap
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 AbstractObject2BooleanMap

containsValue

public boolean containsValue(Object ov)
Specified by:
containsValue in interface Map
Overrides:
containsValue in class AbstractObject2BooleanMap

removeBoolean

public boolean removeBoolean(Object k)
Description copied from interface: Object2BooleanMap
Removes the mapping with the given key.

Specified by:
removeBoolean in interface Object2BooleanMap
Overrides:
removeBoolean in class AbstractObject2BooleanMap

getBoolean

public boolean getBoolean(Object k)
Description copied from interface: Object2BooleanMap
Returns the value to which the given key is mapped.

Specified by:
getBoolean in interface Object2BooleanMap
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)