it.unimi.dsi.fastutil.chars
Class Char2FloatFunctions.EmptyFunction

java.lang.Object
  extended by it.unimi.dsi.fastutil.chars.AbstractChar2FloatFunction
      extended by it.unimi.dsi.fastutil.chars.Char2FloatFunctions.EmptyFunction
All Implemented Interfaces:
Char2FloatFunction, Function<java.lang.Character,java.lang.Float>, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
Char2FloatMaps.EmptyMap
Enclosing class:
Char2FloatFunctions

public static class Char2FloatFunctions.EmptyFunction
extends AbstractChar2FloatFunction
implements java.io.Serializable, java.lang.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

Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 java.lang.Object clone()
           
 boolean containsKey(char k)
           
 float defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(float defRetValue)
          Sets the default return value.
 float get(char k)
          Returns the value to which the given key is mapped.
 java.lang.Float get(java.lang.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 it.unimi.dsi.fastutil.chars.AbstractChar2FloatFunction
containsKey, put, put, remove, remove
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public float get(char k)
Description copied from interface: Char2FloatFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Char2FloatFunction
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 Char2FloatFunction
See Also:
Function.containsKey(Object)

defaultReturnValue

public float defaultReturnValue()
Description copied from interface: Char2FloatFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Char2FloatFunction
Overrides:
defaultReturnValue in class AbstractChar2FloatFunction
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(float defRetValue)
Description copied from interface: Char2FloatFunction
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 Char2FloatFunction
Overrides:
defaultReturnValue in class AbstractChar2FloatFunction
Parameters:
defRetValue - the new default return value.
See Also:
Char2FloatFunction.defaultReturnValue()

get

public java.lang.Float get(java.lang.Object k)
Description copied from class: AbstractChar2FloatFunction
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<java.lang.Character,java.lang.Float>
Overrides:
get in class AbstractChar2FloatFunction
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<java.lang.Character,java.lang.Float>
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<java.lang.Character,java.lang.Float>
Overrides:
clear in class AbstractChar2FloatFunction
See Also:
Map.clear()

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object