it.unimi.dsi.fastutil.shorts

Class Short2ObjectMaps.UnmodifiableMap<V>

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction<V>

it.unimi.dsi.fastutil.shorts.Short2ObjectFunctions.UnmodifiableFunction<V>

it.unimi.dsi.fastutil.shorts.Short2ObjectMaps.UnmodifiableMap<V>

All Implemented Interfaces:

Function<Short,V>, Short2ObjectFunction<V>, Short2ObjectMap<V>, Serializable, Map<Short,V>

Direct Known Subclasses:

Short2ObjectSortedMaps.UnmodifiableSortedMap

Enclosing class:

Short2ObjectMaps

public static class Short2ObjectMaps.UnmodifiableMap<V>
extends Short2ObjectFunctions.UnmodifiableFunction<V>
implements Short2ObjectMap<V>, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.shorts.Short2ObjectMap

Short2ObjectMap.Entry<V>, Short2ObjectMap.FastEntrySet<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Short2ObjectMap.Entry<V>>	entries
protected ShortSet	keys
protected Short2ObjectMap<V>	map
static long	serialVersionUID
protected ObjectCollection<V>	values

Fields inherited from class it.unimi.dsi.fastutil.shorts.Short2ObjectFunctions.UnmodifiableFunction

function

Fields inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Short2ObjectMaps.UnmodifiableMap(Short2ObjectMap<V> m)

Method Summary

Methods

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

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ObjectFunction

put

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

map

protected final Short2ObjectMap<V> map

entries

protected transient volatile ObjectSet<Short2ObjectMap.Entry<V>> entries

keys

protected transient volatile ShortSet keys

values

protected transient volatile ObjectCollection<V> values

Constructor Detail

Short2ObjectMaps.UnmodifiableMap

protected Short2ObjectMaps.UnmodifiableMap(Short2ObjectMap<V> m)

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

Specified by:

size in interface Map<Short,V>

Overrides:

size in class Short2ObjectFunctions.UnmodifiableFunction<V>

Returns:

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

containsKey

public boolean containsKey(short k)

Specified by:

containsKey in interface Short2ObjectFunction<V>

Overrides:

containsKey in class Short2ObjectFunctions.UnmodifiableFunction<V>

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(Object v)

Specified by:

containsValue in interface Map<Short,V>

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Short2ObjectFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Short2ObjectFunction<V>

Overrides:

defaultReturnValue in class Short2ObjectFunctions.UnmodifiableFunction<V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Short2ObjectFunction

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

Overrides:

defaultReturnValue in class Short2ObjectFunctions.UnmodifiableFunction<V>

Parameters:

defRetValue - the new default return value.

See Also:

Short2ObjectFunction.defaultReturnValue()

put

public V put(short k,
    V v)

Description copied from interface: Short2ObjectFunction

Adds a pair to the map.

Specified by:

put in interface Short2ObjectFunction<V>

Overrides:

put in class Short2ObjectFunctions.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(Map<? extends Short,? extends V> m)

Specified by:

putAll in interface Map<Short,V>

short2ObjectEntrySet

public ObjectSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()

Description copied from interface: Short2ObjectMap

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

short2ObjectEntrySet in interface Short2ObjectMap<V>

Returns:

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

See Also:

Short2ObjectMap.entrySet()

keySet

public ShortSet keySet()

Description copied from interface: Short2ObjectMap

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

Specified by:

keySet in interface Map<Short,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: Short2ObjectMap

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

Specified by:

values in interface Map<Short,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<Short,V>

Specified by:

clear in interface Map<Short,V>

Overrides:

clear in class Short2ObjectFunctions.UnmodifiableFunction<V>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Short2ObjectFunctions.UnmodifiableFunction<V>

remove

public V remove(short k)

Description copied from interface: Short2ObjectFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2ObjectFunction<V>

Overrides:

remove in class Short2ObjectFunctions.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(short k)

Description copied from interface: Short2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Short2ObjectFunction<V>

Overrides:

get in class Short2ObjectFunctions.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(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<Short,V>

Specified by:

containsKey in interface Map<Short,V>

Overrides:

containsKey in class Short2ObjectFunctions.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(Object k)

Description copied from class: AbstractShort2ObjectFunction

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

Specified by:

remove in interface Map<Short,V>

Overrides:

remove in class Short2ObjectFunctions.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(Object k)

Description copied from class: AbstractShort2ObjectFunction

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

Specified by:

get in interface Map<Short,V>

Overrides:

get in class Short2ObjectFunctions.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 Map<Short,V>

entrySet

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

Description copied from interface: Short2ObjectMap

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

Specified by:

entrySet in interface Map<Short,V>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()