Package it.unimi.dsi.fastutil.objects
Class Object2FloatFunctions.UnmodifiableFunction<K>
java.lang.Object
it.unimi.dsi.fastutil.objects.AbstractObject2FloatFunction<K>
it.unimi.dsi.fastutil.objects.Object2FloatFunctions.UnmodifiableFunction<K>
- All Implemented Interfaces:
Function<K,Float>,Object2FloatFunction<K>,Serializable,Function<K,Float>,ToDoubleFunction<K>
- Direct Known Subclasses:
Object2FloatMaps.UnmodifiableMap
- Enclosing class:
- Object2FloatFunctions
public static class Object2FloatFunctions.UnmodifiableFunction<K> extends AbstractObject2FloatFunction<K> implements Serializable
An unmodifiable wrapper class for functions.
- See Also:
- Serialized Form
-
Method Summary
Modifier and Type Method Description voidclear()Removes all associations from this function (optional operation).booleancontainsKey(Object k)Returns true if this function contains a mapping for the specified key.floatdefaultReturnValue()Gets the default return value.voiddefaultReturnValue(float defRetValue)Sets the default return value (optional operation).booleanequals(Object o)Floatget(Object k)Deprecated.Please use the corresponding type-specific method instead.floatgetFloat(Object k)Returns the value to which the given key is mapped.inthashCode()floatput(K k, float v)Adds a pair to the map (optional operation).Floatput(K k, Float v)Deprecated.Please use the corresponding type-specific method instead.Floatremove(Object k)Deprecated.Please use the corresponding type-specific method instead.floatremoveFloat(Object k)Removes the mapping with the given key (optional operation).intsize()Returns the intended number of keys in this function, or -1 if no such number exists.StringtoString()
-
Method Details
-
size
public int size()Description copied from interface:FunctionReturns 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. This default implementation, in particular, returns -1.
-
defaultReturnValue
public float defaultReturnValue()Description copied from interface:Object2FloatFunctionGets the default return value.This default implementation just return the default null value of the type (
nullfor objects, 0 for scalars, false for Booleans).- Specified by:
defaultReturnValuein interfaceObject2FloatFunction<K>- Overrides:
defaultReturnValuein classAbstractObject2FloatFunction<K>- Returns:
- the current default return value.
-
defaultReturnValue
public void defaultReturnValue(float defRetValue)Description copied from interface:Object2FloatFunctionSets the default return value (optional operation). This value must be returned by type-specific versions ofget(),put()andremove()to denote that the map does not contain the specified key. It must be 0/false/nullby default.- Specified by:
defaultReturnValuein interfaceObject2FloatFunction<K>- Overrides:
defaultReturnValuein classAbstractObject2FloatFunction<K>- Parameters:
defRetValue- the new default return value.- See Also:
Object2FloatFunction.defaultReturnValue()
-
containsKey
Description copied from interface:FunctionReturns 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. This default implementation, in particular, always return true.
- Specified by:
containsKeyin interfaceFunction<K,Float>- Parameters:
k- the key.- Returns:
- true if this function associates a value to
key. - See Also:
Map.containsKey(Object)
-
put
Description copied from interface:Object2FloatFunctionAdds a pair to the map (optional operation).- Specified by:
putin interfaceObject2FloatFunction<K>- 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)
-
getFloat
Description copied from interface:Object2FloatFunctionReturns the value to which the given key is mapped.- Specified by:
getFloatin interfaceObject2FloatFunction<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)
-
removeFloat
Description copied from interface:Object2FloatFunctionRemoves the mapping with the given key (optional operation).- Specified by:
removeFloatin interfaceObject2FloatFunction<K>- Parameters:
k- the key.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
Function.remove(Object)
-
clear
public void clear()Description copied from interface:FunctionRemoves all associations from this function (optional operation).- Specified by:
clearin interfaceFunction<K,Float>- See Also:
Map.clear()
-
put
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).- Specified by:
putin interfaceFunction<K,Float>- Specified by:
putin interfaceObject2FloatFunction<K>- Parameters:
k- the key.v- the value.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.- Specified by:
getin interfaceFunction<K,Float>- Specified by:
getin interfaceObject2FloatFunction<K>- Parameters:
k- the key.- Returns:
- the corresponding value, or
nullif no value was present for the given key. - See Also:
Map.get(Object)
-
remove
Deprecated.Please use the corresponding type-specific method instead.Removes this key and the associated value from this function if it is present (optional operation).- Specified by:
removein interfaceFunction<K,Float>- Specified by:
removein interfaceObject2FloatFunction<K>- Parameters:
k- the key.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.remove(Object)
-
hashCode
public int hashCode() -
equals
-
toString
-