AbstractReferencedValueMap.ReferencableValue (Arakhnê Foundation Classes 17.0 API)

Type Parameters:

K - is the type of the map keys.

V - is the type of the map values.

All Superinterfaces:

Map.Entry<K,V>

All Known Implementing Classes:

AbstractReferencedValueMap.PhantomReferencedValue, AbstractReferencedValueMap.SoftReferencedValue, AbstractReferencedValueMap.WeakReferencedValue

Enclosing class:

AbstractReferencedValueMap<K,V>
```
protected static interface AbstractReferencedValueMap.ReferencableValue<K,V>
extends Map.Entry<K,V>
```
This interface provides information about the pairs inside a map with weak/soft reference values.

Version:

17.0 2020-01-04 14:41:38

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

references

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clear()`	Clear the reference.
`boolean`	`enqueue()`	Enqueue the value.
`V`	`get()`	Replies the value.
`boolean`	`isEnqueued()`	Replies if a value is enqueued.

Methods inherited from interface java.util.Map.Entry
equals, getKey, getValue, hashCode, setValue

- Method Detail
  - isEnqueued
```
boolean isEnqueued()
```
    Replies if a value is enqueued.
    
    Returns:
    
    if the value is enqueued into a reference queue.
  - get
```
V get()
```
    Replies the value.
    
    Returns:
    
    the weak/soft reference.
  - enqueue
```
boolean enqueue()
```
    Enqueue the value.
    
    Returns:
    
    if the value was enqueued
  - clear
```
void clear()
```
    Clear the reference.