it.unimi.dsi.fastutil.shorts
Class Short2ByteMaps.UnmodifiableMap

java.lang.Object
  it.unimi.dsi.fastutil.shorts.AbstractShort2ByteFunction
      it.unimi.dsi.fastutil.shorts.Short2ByteFunctions.UnmodifiableFunction
          it.unimi.dsi.fastutil.shorts.Short2ByteMaps.UnmodifiableMap

All Implemented Interfaces:

Function<Short,Byte>, Short2ByteFunction, Short2ByteMap, Serializable, Map<Short,Byte>

Direct Known Subclasses:

Short2ByteSortedMaps.UnmodifiableSortedMap

Enclosing class:

Short2ByteMaps

public static class Short2ByteMaps.UnmodifiableMap
extends Short2ByteFunctions.UnmodifiableFunction
implements Short2ByteMap, 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.Short2ByteMap

Short2ByteMap.Entry, Short2ByteMap.FastEntrySet

Field Summary

static long

serialVersionUID

Method Summary

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(byte v)
boolean	containsValue(Object ov)
byte	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(byte defRetValue) Sets the default return value.
ObjectSet<Map.Entry<Short,Byte>>	entrySet() Returns a set view of the mappings contained in this map.
byte	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.
byte	put(short k, byte v) Adds a pair to the map.
Byte	put(Short k, Byte v) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
void	putAll(Map<? extends Short,? extends Byte> m)
byte	remove(short k) Removes the mapping with the given key.
ObjectSet<Short2ByteMap.Entry>	short2ByteEntrySet() 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()
ByteCollection	values() Returns a set view of the values contained in this map.

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

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

Methods inherited from interface java.util.Map

equals, get, hashCode, 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<Short,Byte>

Specified by:

size in interface Map<Short,Byte>

Overrides:

size in class Short2ByteFunctions.UnmodifiableFunction

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 Short2ByteFunction

Overrides:

containsKey in class Short2ByteFunctions.UnmodifiableFunction

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(byte v)

Specified by:

containsValue in interface Short2ByteMap

See Also:

Map.containsValue(Object)

defaultReturnValue

public byte defaultReturnValue()

Description copied from interface: Short2ByteFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Short2ByteFunction

Overrides:

defaultReturnValue in class Short2ByteFunctions.UnmodifiableFunction

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(byte defRetValue)

Description copied from interface: Short2ByteFunction

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 Short2ByteFunction

Overrides:

defaultReturnValue in class Short2ByteFunctions.UnmodifiableFunction

Parameters:

defRetValue - the new default return value.

See Also:

Short2ByteFunction.defaultReturnValue()

put

public byte put(short k,
                byte v)

Description copied from interface: Short2ByteFunction

Adds a pair to the map.

Specified by:

put in interface Short2ByteFunction

Overrides:

put in class Short2ByteFunctions.UnmodifiableFunction

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 Byte> m)

Specified by:

putAll in interface Map<Short,Byte>

short2ByteEntrySet

public ObjectSet<Short2ByteMap.Entry> short2ByteEntrySet()

Description copied from interface: Short2ByteMap

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

Specified by:

short2ByteEntrySet in interface Short2ByteMap

Returns:

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

See Also:

Short2ByteMap.entrySet()

keySet

public ShortSet keySet()

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Specified by:

keySet in interface Map<Short,Byte>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ByteCollection values()

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Specified by:

values in interface Map<Short,Byte>

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

Specified by:

clear in interface Map<Short,Byte>

Overrides:

clear in class Short2ByteFunctions.UnmodifiableFunction

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Short2ByteFunctions.UnmodifiableFunction

put

public Byte put(Short k,
                Byte v)

Description copied from class: AbstractShort2ByteFunction

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

Specified by:

put in interface Map<Short,Byte>

Overrides:

put in class AbstractShort2ByteFunction

Parameters:

k - the key.

v - the value.

Returns:

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

See Also:

Map.put(Object,Object)

remove

public byte remove(short k)

Description copied from interface: Short2ByteFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2ByteFunction

Overrides:

remove in class Short2ByteFunctions.UnmodifiableFunction

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 byte get(short k)

Description copied from interface: Short2ByteFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Short2ByteFunction

Overrides:

get in class Short2ByteFunctions.UnmodifiableFunction

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

Specified by:

containsKey in interface Map<Short,Byte>

Overrides:

containsKey in class Short2ByteFunctions.UnmodifiableFunction

Parameters:

ok - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map<Short,Byte>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Short,Byte>

entrySet

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

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Specified by:

entrySet in interface Map<Short,Byte>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()