it.unimi.dsi.fastutil.chars

Class Char2CharMaps.UnmodifiableMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction

it.unimi.dsi.fastutil.chars.Char2CharFunctions.UnmodifiableFunction

it.unimi.dsi.fastutil.chars.Char2CharMaps.UnmodifiableMap

All Implemented Interfaces:

Char2CharFunction, Char2CharMap, Function<Character,Character>, Serializable, Map<Character,Character>

Direct Known Subclasses:

Char2CharSortedMaps.UnmodifiableSortedMap

Enclosing class:

Char2CharMaps

public static class Char2CharMaps.UnmodifiableMap
extends Char2CharFunctions.UnmodifiableFunction
implements Char2CharMap, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2CharMap

Char2CharMap.Entry, Char2CharMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Char2CharMap.Entry>	entries
protected CharSet	keys
protected Char2CharMap	map
static long	serialVersionUID
protected CharCollection	values

Fields inherited from class it.unimi.dsi.fastutil.chars.Char2CharFunctions.UnmodifiableFunction

function

Fields inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Char2CharMaps.UnmodifiableMap(Char2CharMap m)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectSet<Char2CharMap.Entry>	char2CharEntrySet() 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(char 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<Character,Character>>	entrySet() Returns a set view of the mappings contained in this map.
char	get(char k) Returns the value to which the given key is mapped.
boolean	isEmpty()
CharSet	keySet() Returns a set view of the keys contained in this map.
Character	put(Character k, Character v) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
char	put(char k, char v) Adds a pair to the map.
void	putAll(Map<? extends Character,? extends Character> m)
char	remove(char 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.chars.AbstractChar2CharFunction

get, remove

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

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

map

protected final Char2CharMap map

entries

protected transient volatile ObjectSet<Char2CharMap.Entry> entries

keys

protected transient volatile CharSet keys

values

protected transient volatile CharCollection values

Constructor Detail

Char2CharMaps.UnmodifiableMap

protected Char2CharMaps.UnmodifiableMap(Char2CharMap 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<Character,Character>

Specified by:

size in interface Map<Character,Character>

Overrides:

size in class Char2CharFunctions.UnmodifiableFunction

Returns:

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

containsKey

public boolean containsKey(char k)

Specified by:

containsKey in interface Char2CharFunction

Overrides:

containsKey in class Char2CharFunctions.UnmodifiableFunction

See Also:

Function.containsKey(Object)

containsValue

public boolean containsValue(char v)

Specified by:

containsValue in interface Char2CharMap

See Also:

Map.containsValue(Object)

defaultReturnValue

public char defaultReturnValue()

Description copied from interface: Char2CharFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Char2CharFunction

Overrides:

defaultReturnValue in class Char2CharFunctions.UnmodifiableFunction

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(char defRetValue)

Description copied from interface: Char2CharFunction

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 Char2CharFunction

Overrides:

defaultReturnValue in class Char2CharFunctions.UnmodifiableFunction

Parameters:

defRetValue - the new default return value.

See Also:

Char2CharFunction.defaultReturnValue()

put

public char put(char k,
       char v)

Description copied from interface: Char2CharFunction

Adds a pair to the map.

Specified by:

put in interface Char2CharFunction

Overrides:

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

Specified by:

putAll in interface Map<Character,Character>

char2CharEntrySet

public ObjectSet<Char2CharMap.Entry> char2CharEntrySet()

Description copied from interface: Char2CharMap

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

char2CharEntrySet in interface Char2CharMap

Returns:

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

See Also:

Char2CharMap.entrySet()

keySet

public CharSet keySet()

Description copied from interface: Char2CharMap

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 Char2CharMap

Specified by:

keySet in interface Map<Character,Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public CharCollection values()

Description copied from interface: Char2CharMap

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 Char2CharMap

Specified by:

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

Specified by:

clear in interface Map<Character,Character>

Overrides:

clear in class Char2CharFunctions.UnmodifiableFunction

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Char2CharFunctions.UnmodifiableFunction

put

public Character put(Character k,
            Character v)

Description copied from class: AbstractChar2CharFunction

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

Specified by:

put in interface Map<Character,Character>

Overrides:

put in class AbstractChar2CharFunction

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

Description copied from interface: Char2CharFunction

Removes the mapping with the given key.

Specified by:

remove in interface Char2CharFunction

Overrides:

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

Description copied from interface: Char2CharFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2CharFunction

Overrides:

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

Specified by:

containsKey in interface Map<Character,Character>

Overrides:

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

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character,Character>

entrySet

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

Description copied from interface: Char2CharMap

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 Char2CharMap

Specified by:

entrySet in interface Map<Character,Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()