it.unimi.dsi.fastutil.ints
Class Int2ObjectMaps.UnmodifiableMap<V>

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2ObjectFunction<V>
      it.unimi.dsi.fastutil.ints.Int2ObjectFunctions.UnmodifiableFunction<V>
          it.unimi.dsi.fastutil.ints.Int2ObjectMaps.UnmodifiableMap<V>

All Implemented Interfaces:

Function<java.lang.Integer,V>, Int2ObjectFunction<V>, Int2ObjectMap<V>, java.io.Serializable, java.util.Map<java.lang.Integer,V>

Direct Known Subclasses:

Int2ObjectSortedMaps.UnmodifiableSortedMap

Enclosing class:

Int2ObjectMaps

public static class Int2ObjectMaps.UnmodifiableMap<V>
extends Int2ObjectFunctions.UnmodifiableFunction<V>
implements Int2ObjectMap<V>, 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.ints.Int2ObjectMap

Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>

Method Summary

void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(int k)
boolean	containsKey(java.lang.Object ok) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(java.lang.Object v)
V	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(V defRetValue) Sets the default return value.
ObjectSet<java.util.Map.Entry<java.lang.Integer,V>>	entrySet() Returns a set view of the mappings contained in this map.
V	get(int k) Returns the value to which the given key is mapped.
V	get(java.lang.Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
ObjectSet<Int2ObjectMap.Entry<V>>	int2ObjectEntrySet() Returns a type-specific set view of the mappings contained in this map.
boolean	isEmpty()
IntSet	keySet() Returns a set view of the keys contained in this map.
V	put(int k, V v) Adds a pair to the map.
void	putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
V	remove(int k) Removes the mapping with the given key.
V	remove(java.lang.Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
java.lang.String	toString()
ObjectCollection<V>	values() Returns a set view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ObjectFunction

put

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.Function

put

Methods inherited from interface java.util.Map

equals, hashCode, put

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.Integer,V>

Specified by:

size in interface java.util.Map<java.lang.Integer,V>

Overrides:

size in class Int2ObjectFunctions.UnmodifiableFunction<V>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(int k)

Specified by:

containsKey in interface Int2ObjectFunction<V>

Overrides:

containsKey in class Int2ObjectFunctions.UnmodifiableFunction<V>

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object v)

Specified by:

containsValue in interface java.util.Map<java.lang.Integer,V>

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Int2ObjectFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Int2ObjectFunction<V>

Overrides:

defaultReturnValue in class Int2ObjectFunctions.UnmodifiableFunction<V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Int2ObjectFunction

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 Int2ObjectFunction<V>

Overrides:

defaultReturnValue in class Int2ObjectFunctions.UnmodifiableFunction<V>

Parameters:

defRetValue - the new default return value.

See Also:

Int2ObjectFunction.defaultReturnValue()

put

public V put(int k,
             V v)

Description copied from interface: Int2ObjectFunction

Adds a pair to the map.

Specified by:

put in interface Int2ObjectFunction<V>

Overrides:

put in class Int2ObjectFunctions.UnmodifiableFunction<V>

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.Integer,? extends V> m)

Specified by:

putAll in interface java.util.Map<java.lang.Integer,V>

int2ObjectEntrySet

public ObjectSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()

Description copied from interface: Int2ObjectMap

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 Int2ObjectMap.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:

int2ObjectEntrySet in interface Int2ObjectMap<V>

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Int2ObjectMap.entrySet()

keySet

public IntSet keySet()

Description copied from interface: Int2ObjectMap

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 Int2ObjectMap<V>

Specified by:

keySet in interface java.util.Map<java.lang.Integer,V>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ObjectCollection<V> values()

Description copied from interface: Int2ObjectMap

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 Int2ObjectMap<V>

Specified by:

values in interface java.util.Map<java.lang.Integer,V>

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.Integer,V>

Specified by:

clear in interface java.util.Map<java.lang.Integer,V>

Overrides:

clear in class Int2ObjectFunctions.UnmodifiableFunction<V>

See Also:

Map.clear()

toString

public java.lang.String toString()

Overrides:

toString in class Int2ObjectFunctions.UnmodifiableFunction<V>

remove

public V remove(int k)

Description copied from interface: Int2ObjectFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2ObjectFunction<V>

Overrides:

remove in class Int2ObjectFunctions.UnmodifiableFunction<V>

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 V get(int k)

Description copied from interface: Int2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2ObjectFunction<V>

Overrides:

get in class Int2ObjectFunctions.UnmodifiableFunction<V>

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.Integer,V>

Specified by:

containsKey in interface java.util.Map<java.lang.Integer,V>

Overrides:

containsKey in class Int2ObjectFunctions.UnmodifiableFunction<V>

Parameters:

ok - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

remove

public V remove(java.lang.Object k)

Description copied from class: AbstractInt2ObjectFunction

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 Function<java.lang.Integer,V>

Specified by:

remove in interface java.util.Map<java.lang.Integer,V>

Overrides:

remove in class Int2ObjectFunctions.UnmodifiableFunction<V>

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

get

public V get(java.lang.Object k)

Description copied from class: AbstractInt2ObjectFunction

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 Function<java.lang.Integer,V>

Specified by:

get in interface java.util.Map<java.lang.Integer,V>

Overrides:

get in class Int2ObjectFunctions.UnmodifiableFunction<V>

Parameters:

k - the key.

Returns:

the corresponding value, or null if no value was present for the given key.

See Also:

Map.get(Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Integer,V>

entrySet

public ObjectSet<java.util.Map.Entry<java.lang.Integer,V>> entrySet()

Description copied from interface: Int2ObjectMap

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 Int2ObjectMap<V>

Specified by:

entrySet in interface java.util.Map<java.lang.Integer,V>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()