Int2ShortFunctions.SynchronizedFunction (fastutil 6.4.1 API)

java.lang.Object
- it.unimi.dsi.fastutil.ints.AbstractInt2ShortFunction
- - it.unimi.dsi.fastutil.ints.Int2ShortFunctions.SynchronizedFunction

All Implemented Interfaces:

Function<Integer,Short>, Int2ShortFunction, Serializable

Direct Known Subclasses:

Int2ShortMaps.SynchronizedMap

Enclosing class:

Int2ShortFunctions
```
public static class Int2ShortFunctions.SynchronizedFunction
extends AbstractInt2ShortFunction
implements Serializable
```
A synchronized wrapper class for functions.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Int2ShortFunction function

static long serialVersionUID

protected Object sync
- Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ShortFunction
  defRetValue

Fields
Modifier and Type	Field and Description
`protected Int2ShortFunction`	`function`
`static long`	`serialVersionUID`
`protected Object`	`sync`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Int2ShortFunctions.SynchronizedFunction(Int2ShortFunction f)`
`protected`	`Int2ShortFunctions.SynchronizedFunction(Int2ShortFunction f, Object sync)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all associations from this function (optional operation).
`boolean`	`containsKey(int k)`
`boolean`	`containsKey(Object ok)` Returns true if this function contains a mapping for the specified key.
`short`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(short defRetValue)` Sets the default return value.
`short`	`get(int k)` Returns the value to which the given key is mapped.
`Short`	`get(Object k)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`Short`	`put(Integer k, Short v)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`short`	`put(int k, short v)` Adds a pair to the map.
`short`	`remove(int k)` Removes the mapping with the given key.
`Short`	`remove(Object k)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`int`	`size()` Returns the intended number of keys in this function, or -1 if no such number exists.
`String`	`toString()`

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

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - function
```
protected final Int2ShortFunction function
```
  - sync
```
protected final Object sync
```
- Constructor Detail
  - Int2ShortFunctions.SynchronizedFunction
```
protected Int2ShortFunctions.SynchronizedFunction(Int2ShortFunction f,
                                       Object sync)
```
  - Int2ShortFunctions.SynchronizedFunction
```
protected Int2ShortFunctions.SynchronizedFunction(Int2ShortFunction f)
```
- Method Detail
  - 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<Integer,Short>
    
    Returns:
    the intended number of keys in this function, or -1 if that number is not available.
  - containsKey
```
public boolean containsKey(int k)
```
    Specified by:
    
    containsKey in interface Int2ShortFunction
    
    See Also:
    Function.containsKey(Object)
  - defaultReturnValue
```
public short defaultReturnValue()
```
    Description copied from interface: Int2ShortFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Int2ShortFunction
    
    Overrides:
    
    defaultReturnValue in class AbstractInt2ShortFunction
    
    Returns:
    the current default return value.
  - defaultReturnValue
```
public void defaultReturnValue(short defRetValue)
```
    Description copied from interface: Int2ShortFunction
    
    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 Int2ShortFunction
    
    Overrides:
    
    defaultReturnValue in class AbstractInt2ShortFunction
    
    Parameters:
    defRetValue - the new default return value.
    See Also:
    Int2ShortFunction.defaultReturnValue()
  - put
```
public short put(int k,
        short v)
```
    Description copied from interface: Int2ShortFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Int2ShortFunction
    
    Overrides:
    
    put in class AbstractInt2ShortFunction
    
    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)
  - clear
```
public void clear()
```
    Description copied from interface: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<Integer,Short>
    
    Overrides:
    
    clear in class AbstractInt2ShortFunction
    
    See Also:
    Map.clear()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - put
```
public Short put(Integer k,
        Short v)
```
    Description copied from class: AbstractInt2ShortFunction
    
    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<Integer,Short>
    
    Overrides:
    
    put in class AbstractInt2ShortFunction
    
    Parameters:
    k - the key.
    v - the value.
    
    Returns:
    the old value, or null if no value was present for the given key.
    See Also:
    Map.put(Object,Object)
  - get
```
public Short get(Object k)
```
    Description copied from class: AbstractInt2ShortFunction
    
    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<Integer,Short>
    
    Overrides:
    
    get in class AbstractInt2ShortFunction
    
    Parameters:
    k - the key.
    
    Returns:
    the corresponding value, or null if no value was present for the given key.
    See Also:
    Map.get(Object)
  - remove
```
public Short remove(Object k)
```
    Description copied from class: AbstractInt2ShortFunction
    
    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<Integer,Short>
    
    Overrides:
    
    remove in class AbstractInt2ShortFunction
    
    Returns:
    the old value, or null if no value was present for the given key.
    See Also:
    Map.remove(Object)
  - remove
```
public short remove(int k)
```
    Description copied from interface: Int2ShortFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Int2ShortFunction
    
    Overrides:
    
    remove in class AbstractInt2ShortFunction
    
    Returns:
    the old value, or the default return value if no value was present for the given key.
    See Also:
    Function.remove(Object)
  - get
```
public short get(int k)
```
    Description copied from interface: Int2ShortFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    get in interface Int2ShortFunction
    
    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(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<Integer,Short>
    
    Overrides:
    
    containsKey in class AbstractInt2ShortFunction
    
    Parameters:
    ok - the key.
    
    Returns:
    true if this function associates a value to key.
    See Also:
    Map.containsKey(Object)

Class Int2ShortFunctions.SynchronizedFunction

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2ShortFunction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

function

sync

Constructor Detail

Int2ShortFunctions.SynchronizedFunction

Int2ShortFunctions.SynchronizedFunction

Method Detail

size

containsKey

defaultReturnValue

defaultReturnValue

put

clear

toString

put

get

remove

remove

get

containsKey