it.unimi.dsi.fastutil.objects
Class Object2CharFunctions.EmptyFunction<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2CharFunction<K>
      it.unimi.dsi.fastutil.objects.Object2CharFunctions.EmptyFunction<K>

All Implemented Interfaces:

Function<K,Character>, Object2CharFunction<K>, Serializable, Cloneable

Direct Known Subclasses:

Object2CharMaps.EmptyMap

Enclosing class:

Object2CharFunctions

public static class Object2CharFunctions.EmptyFunction<K>
extends AbstractObject2CharFunction<K>
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

static long

serialVersionUID

Method Summary

void	clear() Removes all associations from this function (optional operation).
Object	clone()
boolean	containsKey(Object k) Returns true if this function contains a mapping for the specified key.
char	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(char defRetValue) Sets the default return value.
char	getChar(Object k) Returns the value to which the given key is mapped.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.

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

get, put, put, remove, removeChar

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

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>

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

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(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 AbstractObject2CharFunction<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 AbstractObject2CharFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Object2CharFunction.defaultReturnValue()

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>

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

Overrides:

clear in class AbstractObject2CharFunction<K>

See Also:

Map.clear()

clone

public Object clone()

Overrides:

clone in class Object