it.unimi.dsi.fastutil.bytes

Class Byte2IntMaps.UnmodifiableMap

java.lang.Object

it.unimi.dsi.fastutil.bytes.AbstractByte2IntFunction

it.unimi.dsi.fastutil.bytes.Byte2IntFunctions.UnmodifiableFunction

it.unimi.dsi.fastutil.bytes.Byte2IntMaps.UnmodifiableMap

All Implemented Interfaces:

Byte2IntFunction, Byte2IntMap, Function<Byte,Integer>, Serializable, Map<Byte,Integer>

Direct Known Subclasses:

Byte2IntSortedMaps.UnmodifiableSortedMap

Enclosing class:

Byte2IntMaps

public static class Byte2IntMaps.UnmodifiableMap
extends Byte2IntFunctions.UnmodifiableFunction
implements Byte2IntMap, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2IntMap

Byte2IntMap.Entry, Byte2IntMap.FastEntrySet

Method Summary

Modifier and Type	Method and Description
ObjectSet<Byte2IntMap.Entry>	byte2IntEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(byte k)
boolean	containsKey(Object ok) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(int v)
boolean	containsValue(Object ov)
int	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(int defRetValue) Sets the default return value.
ObjectSet<Map.Entry<Byte,Integer>>	entrySet() Returns a set view of the mappings contained in this map.
int	get(byte k) Deprecated. Please use the corresponding type-specific method instead.
boolean	isEmpty()
ByteSet	keySet() Returns a set view of the keys contained in this map.
int	put(byte k, int v) Adds a pair to the map.
Integer	put(Byte k, Integer v) Deprecated. Please use the corresponding type-specific method instead.
void	putAll(Map<? extends Byte,? extends Integer> m)
int	remove(byte k) Deprecated. Please use the corresponding type-specific method instead.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
String	toString()
IntCollection	values() Returns a set view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2IntFunction

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

compute, computeIfAbsent, computeIfPresent, equals, forEach, get, getOrDefault, hashCode, merge, putIfAbsent, remove, remove, replace, replace, replaceAll

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

Specified by:

size in interface Map<Byte,Integer>

Overrides:

size in class Byte2IntFunctions.UnmodifiableFunction

Returns:

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

containsKey

public boolean containsKey(byte k)

Specified by:

containsKey in interface Byte2IntFunction

Overrides:

containsKey in class Byte2IntFunctions.UnmodifiableFunction

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(int v)

Specified by:

containsValue in interface Byte2IntMap

See Also:

Map.containsValue(Object)

defaultReturnValue

public int defaultReturnValue()

Description copied from interface: Byte2IntFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Byte2IntFunction

Overrides:

defaultReturnValue in class Byte2IntFunctions.UnmodifiableFunction

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(int defRetValue)

Description copied from interface: Byte2IntFunction

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 Byte2IntFunction

Overrides:

defaultReturnValue in class Byte2IntFunctions.UnmodifiableFunction

Parameters:

defRetValue - the new default return value.

See Also:

Byte2IntFunction.defaultReturnValue()

put

public int put(byte k,
               int v)

Description copied from interface: Byte2IntFunction

Adds a pair to the map.

Specified by:

put in interface Byte2IntFunction

Overrides:

put in class Byte2IntFunctions.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 Byte,? extends Integer> m)

Specified by:

putAll in interface Map<Byte,Integer>

byte2IntEntrySet

public ObjectSet<Byte2IntMap.Entry> byte2IntEntrySet()

Description copied from interface: Byte2IntMap

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

Specified by:

byte2IntEntrySet in interface Byte2IntMap

Returns:

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

See Also:

Byte2IntMap.entrySet()

keySet

public ByteSet keySet()

Description copied from interface: Byte2IntMap

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 Byte2IntMap

Specified by:

keySet in interface Map<Byte,Integer>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public IntCollection values()

Description copied from interface: Byte2IntMap

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 Byte2IntMap

Specified by:

values in interface Map<Byte,Integer>

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

Specified by:

clear in interface Map<Byte,Integer>

Overrides:

clear in class Byte2IntFunctions.UnmodifiableFunction

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Byte2IntFunctions.UnmodifiableFunction

put

@Deprecated
public Integer put(Byte k,
                               Integer v)

Deprecated. Please use the corresponding type-specific method instead.

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

Specified by:

put in interface Map<Byte,Integer>

Overrides:

put in class AbstractByte2IntFunction

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

@Deprecated
public int remove(byte k)

Deprecated. Please use the corresponding type-specific method instead.

Removes the mapping with the given key.

Specified by:

remove in interface Byte2IntFunction

Overrides:

remove in class Byte2IntFunctions.UnmodifiableFunction

Parameters:

k - the key.

Returns:

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

See Also:

Function.remove(Object)

get

@Deprecated
public int get(byte k)

Deprecated. Please use the corresponding type-specific method instead.

Returns the value to which the given key is mapped.

Specified by:

get in interface Byte2IntFunction

Overrides:

get in class Byte2IntFunctions.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<Byte,Integer>

Specified by:

containsKey in interface Map<Byte,Integer>

Overrides:

containsKey in class Byte2IntFunctions.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<Byte,Integer>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Byte,Integer>

entrySet

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

Description copied from interface: Byte2IntMap

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 Byte2IntMap

Specified by:

entrySet in interface Map<Byte,Integer>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()