it.unimi.dsi.fastutil.objects
Class Object2CharMaps.UnmodifiableMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2CharFunction<K>
      it.unimi.dsi.fastutil.objects.Object2CharFunctions.UnmodifiableFunction<K>
          it.unimi.dsi.fastutil.objects.Object2CharMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,Character>, Object2CharFunction<K>, Object2CharMap<K>, Serializable, Map<K,Character>

Direct Known Subclasses:

Object2CharSortedMaps.UnmodifiableSortedMap

Enclosing class:

Object2CharMaps

public static class Object2CharMaps.UnmodifiableMap<K>
extends Object2CharFunctions.UnmodifiableFunction<K>
implements Object2CharMap<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.Object2CharMap

Object2CharMap.Entry<K>, Object2CharMap.FastEntrySet<K>

Field Summary

static long

serialVersionUID

Method Summary

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(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<K,Character>>	entrySet() Returns a set view of the mappings contained in this map.
char	getChar(Object k) Returns the value to which the given key is mapped.
boolean	isEmpty()
ObjectSet<K>	keySet() Returns a set view of the keys contained in this map.
ObjectSet<Object2CharMap.Entry<K>>	object2CharEntrySet() Returns a type-specific set view of the mappings contained in this map.
char	put(K k, char v) Adds a pair to the map.
void	putAll(Map<? extends K,? extends Character> m)
char	removeChar(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()
CharCollection	values() Returns a set view of the values contained in this map.

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

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

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

Specified by:

size in interface Map<K,Character>

Overrides:

size in class Object2CharFunctions.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,Character>

Specified by:

containsKey in interface Map<K,Character>

Overrides:

containsKey in class Object2CharFunctions.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(char v)

Specified by:

containsValue in interface Object2CharMap<K>

See Also:

Map.containsValue(Object)

defaultReturnValue

public char defaultReturnValue()

Description copied from interface: Object2CharFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2CharFunction<K>

Overrides:

defaultReturnValue in class Object2CharFunctions.UnmodifiableFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(char defRetValue)

Description copied from interface: Object2CharFunction

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

Overrides:

defaultReturnValue in class Object2CharFunctions.UnmodifiableFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Object2CharFunction.defaultReturnValue()

put

public char put(K k,
                char v)

Description copied from interface: Object2CharFunction

Adds a pair to the map.

Specified by:

put in interface Object2CharFunction<K>

Overrides:

put in class Object2CharFunctions.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 Character> m)

Specified by:

putAll in interface Map<K,Character>

object2CharEntrySet

public ObjectSet<Object2CharMap.Entry<K>> object2CharEntrySet()

Description copied from interface: Object2CharMap

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

Specified by:

object2CharEntrySet in interface Object2CharMap<K>

Returns:

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

See Also:

Object2CharMap.entrySet()

keySet

public ObjectSet<K> keySet()

Description copied from interface: Object2CharMap

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

Specified by:

keySet in interface Map<K,Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public CharCollection values()

Description copied from interface: Object2CharMap

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

Specified by:

values in interface Map<K,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<K,Character>

Specified by:

clear in interface Map<K,Character>

Overrides:

clear in class Object2CharFunctions.UnmodifiableFunction<K>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object2CharFunctions.UnmodifiableFunction<K>

containsValue

public boolean containsValue(Object ov)

Specified by:

containsValue in interface Map<K,Character>

removeChar

public char removeChar(Object k)

Description copied from interface: Object2CharFunction

Removes the mapping with the given key.

Specified by:

removeChar in interface Object2CharFunction<K>

Overrides:

removeChar in class Object2CharFunctions.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)

getChar

public char getChar(Object k)

Description copied from interface: Object2CharFunction

Returns the value to which the given key is mapped.

Specified by:

getChar in interface Object2CharFunction<K>

Overrides:

getChar in class Object2CharFunctions.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,Character>

entrySet

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

Description copied from interface: Object2CharMap

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

Specified by:

entrySet in interface Map<K,Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()