Package org.codelibs.jhighlight.fastutil.chars

Class Char2ObjectFunctions.EmptyFunction<V>

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

Char2ObjectFunctions

public static class Char2ObjectFunctions.EmptyFunction<V>
extends AbstractChar2ObjectFunction<V>
implements Serializable, Cloneable

An immutable class representing an empty type-specific function.

This class may be useful to implement your own in case you subclass a type-specific function.

See Also:

Serialized Form

Field Summary

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EmptyFunction()

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all associations from this function (optional operation).
Object	clone()
boolean	containsKey(char k)
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.
int	size()	Returns the intended number of keys in this function, or -1 if no such number exists.

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

containsKey, put, put, remove, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyFunction

protected EmptyFunction()

Method Detail

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

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)

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.

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

clone

public Object clone()

Overrides:

clone in class Object