Package com.github.benmanes.caffeine.cache

Class TimerWheel.Sentinel<K,V>

java.lang.Object

com.github.benmanes.caffeine.cache.Node<K,V>

com.github.benmanes.caffeine.cache.TimerWheel.Sentinel<K,V>

All Implemented Interfaces:

AccessOrderDeque.AccessOrder<Node<K,V>>, WriteOrderDeque.WriteOrder<Node<K,V>>

Enclosing class:

TimerWheel<K,V>

static final class TimerWheel.Sentinel<K,V>
extends Node<K,V>

A sentinel for the doubly-linked list in the bucket.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Node<K,V>	next
(package private) Node<K,V>	prev

Fields inherited from class com.github.benmanes.caffeine.cache.Node

PROBATION, PROTECTED, WINDOW

Constructor Summary

Constructors

Constructor	Description
Sentinel()

Method Summary

Modifier and Type	Method	Description
boolean	containsValue(java.lang.Object value)	Returns true if the given objects are considered equivalent.
void	die()	Sets the node to the dead state.
@Nullable K	getKey()	Return the key or null if it has been reclaimed by the garbage collector.
java.lang.Object	getKeyReference()	Returns the reference that the cache is holding the entry by.
Node<K,V>	getNextInVariableOrder()
Node<K,V>	getPreviousInVariableOrder()
@Nullable V	getValue()	Return the value or null if it has been reclaimed by the garbage collector.
java.lang.Object	getValueReference()	Returns the reference to the value.
boolean	isAlive()	If the entry is available in the hash-table and page replacement policy.
boolean	isDead()	If the entry was removed from the hash-table and the page replacement policy.
boolean	isRetired()	If the entry was removed from the hash-table and is awaiting removal from the page replacement policy.
void	retire()	Sets the node to the retired state.
void	setNextInVariableOrder(@Nullable Node<K,V> next)
void	setPreviousInVariableOrder(@Nullable Node<K,V> prev)
void	setValue(V value, @Nullable java.lang.ref.ReferenceQueue<V> referenceQueue)	Sets the value, which may be held strongly, weakly, or softly.

Methods inherited from class com.github.benmanes.caffeine.cache.Node

casVariableTime, casWriteTime, getAccessTime, getNextInAccessOrder, getNextInWriteOrder, getPolicyWeight, getPreviousInAccessOrder, getPreviousInWriteOrder, getQueueType, getVariableTime, getWeight, getWriteTime, inMainProbation, inMainProtected, inWindow, makeMainProbation, makeMainProtected, makeWindow, setAccessTime, setNextInAccessOrder, setNextInWriteOrder, setPolicyWeight, setPreviousInAccessOrder, setPreviousInWriteOrder, setQueueType, setVariableTime, setWeight, setWriteTime, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

prev

Node<K,V> prev

next

Node<K,V> next

Constructor Detail

Sentinel

Sentinel()

Method Detail

getPreviousInVariableOrder

public Node<K,V> getPreviousInVariableOrder()

Overrides:

getPreviousInVariableOrder in class Node<K,V>

setPreviousInVariableOrder

public void setPreviousInVariableOrder(@Nullable Node<K,V> prev)

Overrides:

setPreviousInVariableOrder in class Node<K,V>

getNextInVariableOrder

public Node<K,V> getNextInVariableOrder()

Overrides:

getNextInVariableOrder in class Node<K,V>

setNextInVariableOrder

public void setNextInVariableOrder(@Nullable Node<K,V> next)

Overrides:

setNextInVariableOrder in class Node<K,V>

getKey

public @Nullable K getKey()

Description copied from class: Node

Return the key or null if it has been reclaimed by the garbage collector.

Specified by:

getKey in class Node<K,V>

getKeyReference

public java.lang.Object getKeyReference()

Description copied from class: Node

Returns the reference that the cache is holding the entry by. This is either the key if strongly held or a WeakReference to that key.

Specified by:

getKeyReference in class Node<K,V>

getValue

public @Nullable V getValue()

Description copied from class: Node

Return the value or null if it has been reclaimed by the garbage collector.

Specified by:

getValue in class Node<K,V>

getValueReference

public java.lang.Object getValueReference()

Description copied from class: Node

Returns the reference to the value. This is either the value if strongly held or a Reference to that value.

Specified by:

getValueReference in class Node<K,V>

setValue

public void setValue(V value,
                     @Nullable java.lang.ref.ReferenceQueue<V> referenceQueue)

Description copied from class: Node

Sets the value, which may be held strongly, weakly, or softly. This update may be set lazily and rely on the memory fence when the lock is released.

Specified by:

setValue in class Node<K,V>

containsValue

public boolean containsValue(java.lang.Object value)

Description copied from class: Node

Returns true if the given objects are considered equivalent. A strongly held value is compared by equality and a weakly or softly held value is compared by identity.

Specified by:

containsValue in class Node<K,V>

isAlive

public boolean isAlive()

Description copied from class: Node

If the entry is available in the hash-table and page replacement policy.

Specified by:

isAlive in class Node<K,V>

isRetired

public boolean isRetired()

Description copied from class: Node

If the entry was removed from the hash-table and is awaiting removal from the page replacement policy.

Specified by:

isRetired in class Node<K,V>

isDead

public boolean isDead()

Description copied from class: Node

If the entry was removed from the hash-table and the page replacement policy.

Specified by:

isDead in class Node<K,V>

retire

public void retire()

Description copied from class: Node

Sets the node to the retired state.

Specified by:

retire in class Node<K,V>

die

public void die()

Description copied from class: Node

Sets the node to the dead state.

Specified by:

die in class Node<K,V>