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

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2LongFunction<K>
      extended by it.unimi.dsi.fastutil.objects.Object2LongFunctions.EmptyFunction<K>
All Implemented Interfaces:
Function<K,java.lang.Long>, Object2LongFunction<K>, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
Object2LongMaps.EmptyMap
Enclosing class:
Object2LongFunctions

public static class Object2LongFunctions.EmptyFunction<K>
extends AbstractObject2LongFunction<K>
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(java.lang.Object k)
          Returns true if this function contains a mapping for the specified key.
 long defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(long defRetValue)
          Sets the default return value.
 long getLong(java.lang.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.AbstractObject2LongFunction
get, put, put, remove, removeLong
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getLong

public long getLong(java.lang.Object k)
Description copied from interface: Object2LongFunction
Returns the value to which the given key is mapped.

Specified by:
getLong in interface Object2LongFunction<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(java.lang.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,java.lang.Long>
Parameters:
k - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

defaultReturnValue

public long defaultReturnValue()
Description copied from interface: Object2LongFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Object2LongFunction<K>
Overrides:
defaultReturnValue in class AbstractObject2LongFunction<K>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(long defRetValue)
Description copied from interface: Object2LongFunction
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 Object2LongFunction<K>
Overrides:
defaultReturnValue in class AbstractObject2LongFunction<K>
Parameters:
defRetValue - the new default return value.
See Also:
Object2LongFunction.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,java.lang.Long>
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,java.lang.Long>
Overrides:
clear in class AbstractObject2LongFunction<K>
See Also:
Map.clear()

clone

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