AbstractObject2ShortFunction (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.objects.AbstractObject2ShortFunction<K>

All Implemented Interfaces:

Function<K,java.lang.Short>, Object2ShortFunction<K>, java.io.Serializable

Direct Known Subclasses:

AbstractObject2ShortMap, Object2ShortFunctions.EmptyFunction, Object2ShortFunctions.Singleton, Object2ShortFunctions.SynchronizedFunction, Object2ShortFunctions.UnmodifiableFunction
```
public abstract class AbstractObject2ShortFunction<K>
extends java.lang.Object
implements Object2ShortFunction<K>, java.io.Serializable
```
An abstract class providing basic methods for functions implementing a type-specific interface.
Optional operations just throw an UnsupportedOperationException. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules (they take care of returning null on a missing key).
This class handles directly a default return value (including methods to access it). Instances of classes inheriting from this class have just to return defRetValue to denote lack of a key in type-specific methods. The value is serialized.
Implementing subclasses have just to provide type-specific get(), type-specific containsKey(), and size() methods.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all associations from this function (optional operation).
`short`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(short rv)` Sets the default return value.
`java.lang.Short`	`get(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`short`	`put(K key, short value)` Adds a pair to the map.
`java.lang.Short`	`put(K ok, java.lang.Short ov)` Deprecated. Please use the corresponding type-specific method instead.
`java.lang.Short`	`remove(java.lang.Object ok)` Deprecated. Please use the corresponding type-specific method instead.
`short`	`removeShort(java.lang.Object key)` Removes the mapping with the given key.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ShortFunction
getShort

Methods inherited from interface it.unimi.dsi.fastutil.Function
containsKey, size

- Method Detail
  - defaultReturnValue
```
public void defaultReturnValue(short rv)
```
    Description copied from interface: Object2ShortFunction
    
    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 Object2ShortFunction<K>
    
    Parameters:
    
    rv - the new default return value.
    
    See Also:
    
    Object2ShortFunction.defaultReturnValue()
  - defaultReturnValue
```
public short defaultReturnValue()
```
    Description copied from interface: Object2ShortFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Object2ShortFunction<K>
    
    Returns:
    
    the current default return value.
  - put
```
public short put(K key,
                 short value)
```
    Description copied from interface: Object2ShortFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Object2ShortFunction<K>
    
    Parameters:
    
    key - the key.
    
    value - 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)
  - removeShort
```
public short removeShort(java.lang.Object key)
```
    Description copied from interface: Object2ShortFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    removeShort in interface Object2ShortFunction<K>
    
    Parameters:
    
    key - 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: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<K,java.lang.Short>
    
    See Also:
    
    Map.clear()
  - get
```
@Deprecated
public java.lang.Short get(java.lang.Object ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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<K,java.lang.Short>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)
  - put
```
@Deprecated
public java.lang.Short put(K ok,
                                       java.lang.Short ov)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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:
    
    put in interface Function<K,java.lang.Short>
    
    Parameters:
    
    ok - the key.
    
    ov - the value.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.put(Object,Object)
  - remove
```
@Deprecated
public java.lang.Short remove(java.lang.Object ok)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    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:
    
    remove in interface Function<K,java.lang.Short>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.remove(Object)

Class AbstractObject2ShortFunction<K>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ShortFunction

Methods inherited from interface it.unimi.dsi.fastutil.Function

Method Detail

defaultReturnValue

defaultReturnValue

put

removeShort

clear

get

put

remove