it.unimi.dsi.fastutil.ints
Class Int2CharMaps.UnmodifiableMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction
      it.unimi.dsi.fastutil.ints.Int2CharFunctions.UnmodifiableFunction
          it.unimi.dsi.fastutil.ints.Int2CharMaps.UnmodifiableMap

All Implemented Interfaces:

Function<Integer,Character>, Int2CharFunction, Int2CharMap, Serializable, Map<Integer,Character>

Direct Known Subclasses:

Int2CharSortedMaps.UnmodifiableSortedMap

Enclosing class:

Int2CharMaps

public static class Int2CharMaps.UnmodifiableMap
extends Int2CharFunctions.UnmodifiableFunction
implements Int2CharMap, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2CharMap

Int2CharMap.Entry, Int2CharMap.FastEntrySet

Field Summary

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(int k)
boolean	containsKey(Object ok) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(char v)
boolean	containsValue(Object ov)
char	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(char defRetValue) Sets the default return value.
ObjectSet<Map.Entry<Integer,Character>>	entrySet() Returns a set view of the mappings contained in this map.
char	get(int k) Returns the value to which the given key is mapped.
ObjectSet<Int2CharMap.Entry>	int2CharEntrySet() Returns a type-specific set view of the mappings contained in this map.
boolean	isEmpty()
IntSet	keySet() Returns a set view of the keys contained in this map.
char	put(int k, char v) Adds a pair to the map.
Character	put(Integer k, Character v) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
void	putAll(Map<? extends Integer,? extends Character> m)
char	remove(int 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()
CharCollection	values() Returns a set view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction

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

Specified by:

size in interface Map<Integer,Character>

Overrides:

size in class Int2CharFunctions.UnmodifiableFunction

Returns:

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

containsKey

public boolean containsKey(int k)

Specified by:

containsKey in interface Int2CharFunction

Overrides:

containsKey in class Int2CharFunctions.UnmodifiableFunction

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(char v)

Specified by:

containsValue in interface Int2CharMap

See Also:

Map.containsValue(Object)

defaultReturnValue

public char defaultReturnValue()

Description copied from interface: Int2CharFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Int2CharFunction

Overrides:

defaultReturnValue in class Int2CharFunctions.UnmodifiableFunction

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(char defRetValue)

Description copied from interface: Int2CharFunction

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 Int2CharFunction

Overrides:

defaultReturnValue in class Int2CharFunctions.UnmodifiableFunction

Parameters:

defRetValue - the new default return value.

See Also:

Int2CharFunction.defaultReturnValue()

put

public char put(int k,
                char v)

Description copied from interface: Int2CharFunction

Adds a pair to the map.

Specified by:

put in interface Int2CharFunction

Overrides:

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

Specified by:

putAll in interface Map<Integer,Character>

int2CharEntrySet

public ObjectSet<Int2CharMap.Entry> int2CharEntrySet()

Description copied from interface: Int2CharMap

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

Specified by:

int2CharEntrySet in interface Int2CharMap

Returns:

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

See Also:

Int2CharMap.entrySet()

keySet

public IntSet keySet()

Description copied from interface: Int2CharMap

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 Int2CharMap

Specified by:

keySet in interface Map<Integer,Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public CharCollection values()

Description copied from interface: Int2CharMap

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 Int2CharMap

Specified by:

values in interface Map<Integer,Character>

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

Specified by:

clear in interface Map<Integer,Character>

Overrides:

clear in class Int2CharFunctions.UnmodifiableFunction

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Int2CharFunctions.UnmodifiableFunction

put

public Character put(Integer k,
                     Character v)

Description copied from class: AbstractInt2CharFunction

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

Specified by:

put in interface Map<Integer,Character>

Overrides:

put in class AbstractInt2CharFunction

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 char remove(int k)

Description copied from interface: Int2CharFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2CharFunction

Overrides:

remove in class Int2CharFunctions.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 char get(int k)

Description copied from interface: Int2CharFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2CharFunction

Overrides:

get in class Int2CharFunctions.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<Integer,Character>

Specified by:

containsKey in interface Map<Integer,Character>

Overrides:

containsKey in class Int2CharFunctions.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<Integer,Character>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Integer,Character>

entrySet

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

Description copied from interface: Int2CharMap

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 Int2CharMap

Specified by:

entrySet in interface Map<Integer,Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()