it.unimi.dsi.fastutil.objects
Class Reference2IntMaps.EmptyMap

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractReference2IntMap
      it.unimi.dsi.fastutil.objects.Reference2IntMaps.EmptyMap

All Implemented Interfaces:

Cloneable, Map, Reference2IntMap, Serializable

Direct Known Subclasses:

Reference2IntSortedMaps.EmptySortedMap

Enclosing class:

Reference2IntMaps

public static class Reference2IntMaps.EmptyMap

extends AbstractReference2IntMap

implements Serializable, Cloneable

An immutable class representing an empty type-specific map.

This class may be useful to implement your own in case you subclass a type-specific map.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2IntMap

AbstractReference2IntMap.BasicEntry

Nested classes inherited from class it.unimi.dsi.fastutil.objects.Reference2IntMap

Reference2IntMap.Entry

Field Summary

static long

serialVersionUID

Method Summary

void	clear()
Object	clone()
boolean	containsKey(Object k) Checks whether the given value is contained in keySet().
boolean	containsValue(int v) Checks whether the given value is contained in values().
boolean	containsValue(Object ov)
int	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(int 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.
int	getInt(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.
int	put(Object k, int 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.
int	size()
Collection	values() Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2IntMap

equals, getDefRetValue, hashCode, isEmpty, remove, removeInt, setDefRetValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

put

public int put(Object k,
               int v)

Description copied from interface: Reference2IntMap

Adds a pair to the map.

Specified by:

put in interface Reference2IntMap

Overrides:

put in class AbstractReference2IntMap

get

public Object get(Object ok)

Description copied from class: AbstractReference2IntMap

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 AbstractReference2IntMap

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractReference2IntMap

Checks whether the given value is contained in AbstractReference2IntMap.keySet().

Specified by:

containsKey in interface Map

Overrides:

containsKey in class AbstractReference2IntMap

containsValue

public boolean containsValue(int v)

Description copied from class: AbstractReference2IntMap

Checks whether the given value is contained in AbstractReference2IntMap.values().

Specified by:

containsValue in interface Reference2IntMap

Overrides:

containsValue in class AbstractReference2IntMap

defaultReturnValue

public int defaultReturnValue()

Description copied from interface: Reference2IntMap

Gets the default return value.

Specified by:

defaultReturnValue in interface Reference2IntMap

Overrides:

defaultReturnValue in class AbstractReference2IntMap

defaultReturnValue

public void defaultReturnValue(int defRetValue)

Description copied from interface: Reference2IntMap

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 Reference2IntMap

Overrides:

defaultReturnValue in class AbstractReference2IntMap

putAll

public void putAll(Map m)

Description copied from class: AbstractReference2IntMap

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 AbstractReference2IntMap

Parameters:

m - a map.

entrySet

public Set entrySet()

Specified by:

entrySet in interface Map

keySet

public Set keySet()

Description copied from class: AbstractReference2IntMap

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 AbstractReference2IntMap

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: AbstractReference2IntMap

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 AbstractReference2IntMap

Returns:

a set view of the values of this map; it may be safely cast to a type-specific interface.

put

public Object put(Object k,
                  Object v)

Description copied from class: AbstractReference2IntMap

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 AbstractReference2IntMap

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map

Overrides:

containsValue in class AbstractReference2IntMap

getInt

public int getInt(Object k)

Description copied from interface: Reference2IntMap

Returns the value to which the given key is mapped.

Specified by:

getInt in interface Reference2IntMap

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)

size

public int size()

Specified by:

size in interface Map

clear

public void clear()

Specified by:

clear in interface Map

Overrides:

clear in class AbstractReference2IntMap

clone

public Object clone()