Package org.codelibs.jhighlight.fastutil.chars

Class Char2ObjectFunctions.UnmodifiableFunction<V>

java.lang.Object

org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectFunction<V>

org.codelibs.jhighlight.fastutil.chars.Char2ObjectFunctions.UnmodifiableFunction<V>

All Implemented Interfaces:

Serializable, Char2ObjectFunction<V>, Function<Character,V>

Enclosing class:

Char2ObjectFunctions

public static class Char2ObjectFunctions.UnmodifiableFunction<V>
extends AbstractChar2ObjectFunction<V>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Char2ObjectFunction<V>	function

Fields inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnmodifiableFunction(Char2ObjectFunction<V> f)

Method Summary

Modifier and Type	Method	Description
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.
V	defaultReturnValue()	Gets the default return value.
void	defaultReturnValue(V defRetValue)	Sets the default return value.
V	get(char k)	Returns the value to which the given key is mapped.
V	get(Object k)	Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
V	put(char k, V v)	Adds a pair to the map.
V	remove(char k)	Removes the mapping with the given key.
V	remove(Object k)	Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	size()	Returns the intended number of keys in this function, or -1 if no such number exists.
String	toString()

Methods inherited from class org.codelibs.jhighlight.fastutil.chars.AbstractChar2ObjectFunction

put

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

function

protected final Char2ObjectFunction<V> function

Constructor Detail

UnmodifiableFunction

protected UnmodifiableFunction(Char2ObjectFunction<V> f)

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

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 Char2ObjectFunction<V>

See Also:

Function.containsKey(Object)

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Char2ObjectFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Char2ObjectFunction<V>

Overrides:

defaultReturnValue in class AbstractChar2ObjectFunction<V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Char2ObjectFunction

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 Char2ObjectFunction<V>

Overrides:

defaultReturnValue in class AbstractChar2ObjectFunction<V>

Parameters:

defRetValue - the new default return value.

See Also:

Char2ObjectFunction.defaultReturnValue()

put

public V put(char k,
             V v)

Description copied from interface: Char2ObjectFunction

Adds a pair to the map.

Specified by:

put in interface Char2ObjectFunction<V>

Overrides:

put in class AbstractChar2ObjectFunction<V>

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)

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<Character,V>

Overrides:

clear in class AbstractChar2ObjectFunction<V>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object

remove

public V remove(char k)

Description copied from interface: Char2ObjectFunction

Removes the mapping with the given key.

Specified by:

remove in interface Char2ObjectFunction<V>

Overrides:

remove in class AbstractChar2ObjectFunction<V>

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

Description copied from interface: Char2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Char2ObjectFunction<V>

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

Overrides:

containsKey in class AbstractChar2ObjectFunction<V>

Parameters:

ok - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

remove

public V remove(Object k)

Description copied from class: AbstractChar2ObjectFunction

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:

remove in interface Function<Character,V>

Overrides:

remove in class AbstractChar2ObjectFunction<V>

Returns:

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

See Also:

Map.remove(Object)

get

public V get(Object k)

Description copied from class: AbstractChar2ObjectFunction

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:

get in interface Function<Character,V>

Overrides:

get in class AbstractChar2ObjectFunction<V>

Parameters:

k - the key.

Returns:

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

See Also:

Map.get(Object)