Package it.unimi.dsi.fastutil.chars
Class Char2ObjectFunctions.UnmodifiableFunction<V>
java.lang.Object
it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction<V>
it.unimi.dsi.fastutil.chars.Char2ObjectFunctions.UnmodifiableFunction<V>
- All Implemented Interfaces:
Char2ObjectFunction<V>
,Function<Character,
,V> Serializable
,Function<Character,
,V> IntFunction<V>
- Direct Known Subclasses:
Char2ObjectMaps.UnmodifiableMap
- Enclosing class:
Char2ObjectFunctions
public static class Char2ObjectFunctions.UnmodifiableFunction<V>
extends AbstractChar2ObjectFunction<V>
implements Serializable
An unmodifiable wrapper class for functions.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all associations from this function (optional operation).boolean
containsKey
(char k) Returns true if this function contains a mapping for the specified key.Gets the default return value.void
defaultReturnValue
(V defRetValue) Sets the default return value (optional operation).boolean
get
(char k) Returns the value to which the given key is mapped.Deprecated.Please use the corresponding type-specific method instead.getOrDefault
(char k, V defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.getOrDefault
(Object k, V defaultValue) Deprecated.Please use the corresponding type-specific method instead.int
hashCode()
Adds a pair to the map (optional operation).Deprecated.Please use the corresponding type-specific method instead.remove
(char k) Removes the mapping with the given key (optional operation).Deprecated.Please use the corresponding type-specific method instead.int
size()
Returns the intended number of keys in this function, or -1 if no such number exists.toString()
Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2ObjectFunction
andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, containsKey
-
Method Details
-
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. This default implementation, in particular, returns -1.
-
defaultReturnValue
Description copied from interface:Char2ObjectFunction
Gets the default return value.This default implementation just return the default null value of the type (
null
for objects, 0 for scalars, false for Booleans).- Specified by:
defaultReturnValue
in interfaceChar2ObjectFunction<V>
- Overrides:
defaultReturnValue
in classAbstractChar2ObjectFunction<V>
- Returns:
- the current default return value.
-
defaultReturnValue
Description copied from interface:Char2ObjectFunction
Sets 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
/null
by default.- Specified by:
defaultReturnValue
in interfaceChar2ObjectFunction<V>
- Overrides:
defaultReturnValue
in classAbstractChar2ObjectFunction<V>
- Parameters:
defRetValue
- the new default return value.- See Also:
-
containsKey
public boolean containsKey(char k) Description copied from interface:Char2ObjectFunction
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. In particular, this default implementation always returns true.
- Specified by:
containsKey
in interfaceChar2ObjectFunction<V>
- Parameters:
k
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
-
put
Description copied from interface:Char2ObjectFunction
Adds a pair to the map (optional operation).- Specified by:
put
in interfaceChar2ObjectFunction<V>
- 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:
-
get
Description copied from interface:Char2ObjectFunction
Returns the value to which the given key is mapped.- Specified by:
get
in interfaceChar2ObjectFunction<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:
-
getOrDefault
Description copied from interface:Char2ObjectFunction
Returns the value associated by this function to the specified key, or give the specified value if not present.- Specified by:
getOrDefault
in interfaceChar2ObjectFunction<V>
- Parameters:
k
- the key.defaultValue
- the value to return if not present.- Returns:
- the corresponding value, or
defaultValue
if no value was present for the given key. - See Also:
-
remove
Description copied from interface:Char2ObjectFunction
Removes the mapping with the given key (optional operation).- Specified by:
remove
in interfaceChar2ObjectFunction<V>
- Parameters:
k
- the key.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
-
clear
public void clear()Description copied from interface:Function
Removes all associations from this function (optional operation). -
put
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation). -
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key. -
getOrDefault
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key, or give the specified value if not present.- Specified by:
getOrDefault
in interfaceChar2ObjectFunction<V>
- Specified by:
getOrDefault
in interfaceFunction<Character,
V> - Parameters:
k
- the key.defaultValue
- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValue
if no value was present for the given key. - See Also:
-
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). -
hashCode
public int hashCode() -
equals
-
toString
-