it.unimi.dsi.fastutil.objects
Class Object2LongMaps.UnmodifiableMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2LongFunction<K>
      it.unimi.dsi.fastutil.objects.Object2LongFunctions.UnmodifiableFunction<K>
          it.unimi.dsi.fastutil.objects.Object2LongMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,Long>, Object2LongFunction<K>, Object2LongMap<K>, Serializable, Map<K,Long>

Direct Known Subclasses:

Object2LongSortedMaps.UnmodifiableSortedMap

Enclosing class:

Object2LongMaps

public static class Object2LongMaps.UnmodifiableMap<K>
extends Object2LongFunctions.UnmodifiableFunction<K>
implements Object2LongMap<K>, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2LongMap

Object2LongMap.Entry<K>, Object2LongMap.FastEntrySet<K>

Field Summary

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(Object k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(long v)
boolean	containsValue(Object ov)
long	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(long defRetValue) Sets the default return value.
ObjectSet<Map.Entry<K,Long>>	entrySet() Returns a set view of the mappings contained in this map.
long	getLong(Object k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ObjectSet<K>	keySet() Returns a set view of the keys contained in this map.
ObjectSet<Object2LongMap.Entry<K>>	object2LongEntrySet() Returns a type-specific set view of the mappings contained in this map.
long	put(K k, long v) Adds a pair to the map.
void	putAll(Map<? extends K,? extends Long> m)
long	removeLong(Object 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()
LongCollection	values() Returns a set view of the values contained in this map.

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

get, put, 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, put, remove

Methods inherited from interface java.util.Map

equals, get, hashCode, put, 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<K,Long>

Specified by:

size in interface Map<K,Long>

Overrides:

size in class Object2LongFunctions.UnmodifiableFunction<K>

Returns:

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

containsKey

public boolean containsKey(Object k)

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<K,Long>

Specified by:

containsKey in interface Map<K,Long>

Overrides:

containsKey in class Object2LongFunctions.UnmodifiableFunction<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(long v)

Specified by:

containsValue in interface Object2LongMap<K>

See Also:

Map.containsValue(Object)

defaultReturnValue

public long defaultReturnValue()

Description copied from interface: Object2LongFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2LongFunction<K>

Overrides:

defaultReturnValue in class Object2LongFunctions.UnmodifiableFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(long defRetValue)

Description copied from interface: Object2LongFunction

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 Object2LongFunction<K>

Overrides:

defaultReturnValue in class Object2LongFunctions.UnmodifiableFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Object2LongFunction.defaultReturnValue()

put

public long put(K k,
                long v)

Description copied from interface: Object2LongFunction

Adds a pair to the map.

Specified by:

put in interface Object2LongFunction<K>

Overrides:

put in class Object2LongFunctions.UnmodifiableFunction<K>

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 K,? extends Long> m)

Specified by:

putAll in interface Map<K,Long>

object2LongEntrySet

public ObjectSet<Object2LongMap.Entry<K>> object2LongEntrySet()

Description copied from interface: Object2LongMap

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 Object2LongMap.entrySet() so that it returns an ObjectSet of objects of type Object2LongMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:

object2LongEntrySet in interface Object2LongMap<K>

Returns:

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

See Also:

Object2LongMap.entrySet()

keySet

public ObjectSet<K> keySet()

Description copied from interface: Object2LongMap

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 Object2LongMap<K>

Specified by:

keySet in interface Map<K,Long>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public LongCollection values()

Description copied from interface: Object2LongMap

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 Object2LongMap<K>

Specified by:

values in interface Map<K,Long>

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<K,Long>

Specified by:

clear in interface Map<K,Long>

Overrides:

clear in class Object2LongFunctions.UnmodifiableFunction<K>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object2LongFunctions.UnmodifiableFunction<K>

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map<K,Long>

removeLong

public long removeLong(Object k)

Description copied from interface: Object2LongFunction

Removes the mapping with the given key.

Specified by:

removeLong in interface Object2LongFunction<K>

Overrides:

removeLong in class Object2LongFunctions.UnmodifiableFunction<K>

Returns:

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

See Also:

Function.remove(Object)

getLong

public long getLong(Object k)

Description copied from interface: Object2LongFunction

Returns the value to which the given key is mapped.

Specified by:

getLong in interface Object2LongFunction<K>

Overrides:

getLong in class Object2LongFunctions.UnmodifiableFunction<K>

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)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Long>

entrySet

public ObjectSet<Map.Entry<K,Long>> entrySet()

Description copied from interface: Object2LongMap

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 Object2LongMap<K>

Specified by:

entrySet in interface Map<K,Long>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()