it.unimi.dsi.fastutil.objects

Class Reference2ShortMaps.UnmodifiableMap<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractReference2ShortFunction<K>

it.unimi.dsi.fastutil.objects.Reference2ShortFunctions.UnmodifiableFunction<K>

it.unimi.dsi.fastutil.objects.Reference2ShortMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,Short>, Reference2ShortFunction<K>, Reference2ShortMap<K>, Serializable, Map<K,Short>

Direct Known Subclasses:

Reference2ShortSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2ShortMaps

public static class Reference2ShortMaps.UnmodifiableMap<K>
extends Reference2ShortFunctions.UnmodifiableFunction<K>
implements Reference2ShortMap<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.Reference2ShortMap

Reference2ShortMap.Entry<K>, Reference2ShortMap.FastEntrySet<K>

Method Summary

Methods

Modifier and Type	Method and Description
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(Object ov)
boolean	containsValue(short v)
short	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(short defRetValue) Sets the default return value.
ObjectSet<Map.Entry<K,Short>>	entrySet() Returns a set view of the mappings contained in this map.
short	getShort(Object k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ReferenceSet<K>	keySet() Returns a set view of the keys contained in this map.
short	put(K k, short v) Adds a pair to the map.
void	putAll(Map<? extends K,? extends Short> m)
ObjectSet<Reference2ShortMap.Entry<K>>	reference2ShortEntrySet() Returns a type-specific set view of the mappings contained in this map.
short	removeShort(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()
ShortCollection	values() Returns a set view of the values contained in this map.

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

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

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,Short>

Specified by:

size in interface Map<K,Short>

Overrides:

size in class Reference2ShortFunctions.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,Short>

Specified by:

containsKey in interface Map<K,Short>

Overrides:

containsKey in class Reference2ShortFunctions.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(short v)

Specified by:

containsValue in interface Reference2ShortMap<K>

See Also:

Map.containsValue(Object)

defaultReturnValue

public short defaultReturnValue()

Description copied from interface: Reference2ShortFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Reference2ShortFunction<K>

Overrides:

defaultReturnValue in class Reference2ShortFunctions.UnmodifiableFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(short defRetValue)

Description copied from interface: Reference2ShortFunction

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

Overrides:

defaultReturnValue in class Reference2ShortFunctions.UnmodifiableFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Reference2ShortFunction.defaultReturnValue()

put

public short put(K k,
        short v)

Description copied from interface: Reference2ShortFunction

Adds a pair to the map.

Specified by:

put in interface Reference2ShortFunction<K>

Overrides:

put in class Reference2ShortFunctions.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 Short> m)

Specified by:

putAll in interface Map<K,Short>

reference2ShortEntrySet

public ObjectSet<Reference2ShortMap.Entry<K>> reference2ShortEntrySet()

Description copied from interface: Reference2ShortMap

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

reference2ShortEntrySet in interface Reference2ShortMap<K>

Returns:

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

See Also:

Reference2ShortMap.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2ShortMap

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

Specified by:

keySet in interface Map<K,Short>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ShortCollection values()

Description copied from interface: Reference2ShortMap

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

Specified by:

values in interface Map<K,Short>

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,Short>

Specified by:

clear in interface Map<K,Short>

Overrides:

clear in class Reference2ShortFunctions.UnmodifiableFunction<K>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Reference2ShortFunctions.UnmodifiableFunction<K>

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map<K,Short>

removeShort

public short removeShort(Object k)

Description copied from interface: Reference2ShortFunction

Removes the mapping with the given key.

Specified by:

removeShort in interface Reference2ShortFunction<K>

Overrides:

removeShort in class Reference2ShortFunctions.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)

getShort

public short getShort(Object k)

Description copied from interface: Reference2ShortFunction

Returns the value to which the given key is mapped.

Specified by:

getShort in interface Reference2ShortFunction<K>

Overrides:

getShort in class Reference2ShortFunctions.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,Short>

entrySet

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

Description copied from interface: Reference2ShortMap

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

Specified by:

entrySet in interface Map<K,Short>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()