AbstractInt2ObjectFunction (common 3.5.1 API)

java.lang.Object
- it.unimi.dsi.fastutil.ints.AbstractInt2ObjectFunction<V>

All Implemented Interfaces:

Function<java.lang.Integer,V>, Int2ObjectFunction<V>, java.io.Serializable

Direct Known Subclasses:

AbstractInt2ObjectMap
```
public abstract class AbstractInt2ObjectFunction<V>
extends java.lang.Object
implements Int2ObjectFunction<V>, 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

Field Summary

Fields
Modifier and Type Field and Description

protected V defRetValue
The default return value for get(), put() and remove().

Fields
Modifier and Type	Field and Description
`protected V`	`defRetValue` The default return value for `get()`, `put()` and `remove()`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractInt2ObjectFunction()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractInt2ObjectFunction()`

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).
`boolean`	`containsKey(java.lang.Object ok)` Returns true if this function contains a mapping for the specified key.
`V`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(V rv)` Sets the default return value.
`V`	`get(java.lang.Object ok)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`V`	`put(java.lang.Integer ok, V ov)` Deprecated. Please use the corresponding type-specific method instead.
`V`	`put(int key, V value)` Adds a pair to the map.
`V`	`remove(int key)` Removes the mapping with the given key.
`V`	`remove(java.lang.Object ok)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.

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

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2ObjectFunction
containsKey, get

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

- Field Detail
  - defRetValue
```
protected V defRetValue
```
    The default return value for get(), put() and remove().
- Constructor Detail
  - AbstractInt2ObjectFunction
```
protected AbstractInt2ObjectFunction()
```
- Method Detail
  - defaultReturnValue
```
public void defaultReturnValue(V rv)
```
    Description copied from interface: Int2ObjectFunction
    
    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 Int2ObjectFunction<V>
    
    Parameters:
    
    rv - the new default return value.
    
    See Also:
    
    Int2ObjectFunction.defaultReturnValue()
  - defaultReturnValue
```
public V defaultReturnValue()
```
    Description copied from interface: Int2ObjectFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Int2ObjectFunction<V>
    
    Returns:
    
    the current default return value.
  - put
```
public V put(int key,
             V value)
```
    Description copied from interface: Int2ObjectFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Int2ObjectFunction<V>
    
    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)
  - remove
```
public V remove(int key)
```
    Description copied from interface: Int2ObjectFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Int2ObjectFunction<V>
    
    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<java.lang.Integer,V>
    
    See Also:
    
    Map.clear()
  - containsKey
```
public boolean containsKey(java.lang.Object ok)
```
    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<java.lang.Integer,V>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - get
```
public V get(java.lang.Object ok)
```
    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.Integer,V>
    
    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 V put(java.lang.Integer ok,
                         V 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<java.lang.Integer,V>
    
    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
```
public V remove(java.lang.Object ok)
```
    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<java.lang.Integer,V>
    
    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 AbstractInt2ObjectFunction<V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2ObjectFunction

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

Field Detail

defRetValue

Constructor Detail

AbstractInt2ObjectFunction

Method Detail

defaultReturnValue

defaultReturnValue

put

remove

clear

containsKey

get

put

remove