Modifier and Type	Class and Description
pack-priv class	TimerWheel.AscendingIterator
pack-priv class	TimerWheel.DescendingIterator
pack-priv static class	TimerWheel.Sentinel<K, V> A sentinel for the doubly-linked list in the bucket.
pack-priv abstract class	TimerWheel.Traverser An iterator with rough ordering that can be specialized for either direction.

Modifier and Type	Field and Description
pack-priv static final int[]	BUCKETS
pack-priv long	nanos
pack-priv static final long[]	SHIFT
pack-priv static final long[]	SPANS
pack-priv final Node<K, V>[][]	wheel

Access	Constructor and Description
pack-priv	TimerWheel()

Method Summary

Modifier and Type	Method and Description
public void	advance(BoundedLocalCache<K, V> the instance that the entries belong to cache, long the current time, in nanoseconds currentTimeNanos) Advances the timer and evicts entries that have expired.
public Iterator<Node<K, V>>	descendingIterator() Returns an iterator roughly ordered by the expiration time from the entries least likely to expire (youngest) to the entries most likely to expire (oldest).
public void	deschedule(Node<K, V> the entry in the cache node) Removes a timer event for this entry if present.
pack-priv void	expire(BoundedLocalCache<K, V> the instance that the entries belong to cache, int the timing wheel being operated on index, long the previous number of ticks previousTicks, long the number of additional ticks delta) Expires entries or reschedules into the proper bucket if still active.
pack-priv Node<K, V>	Returns: the sentinel at the head of the bucket findBucket(long the time when the event fires time) Determines the bucket that the timer event should be added to.
public long	getExpirationDelay() Returns the duration until the next bucket expires, or `Long#MAX_VALUE` if none.
public Iterator<Node<K, V>>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator roughly ordered by the expiration time from the entries most likely to expire (oldest) to the entries least likely to expire (youngest).
pack-priv void	link(Node<K, V> sentinel, Node<K, V> node) Adds the entry at the tail of the bucket's list.
pack-priv long	peekAhead(int the timing wheel being operated on index) Returns the duration when the wheel's next bucket expires, or `Long#MAX_VALUE` if empty.
public void	reschedule(Node<K, V> the entry in the cache node) Reschedules an active timer event for the node.
public void	schedule(Node<K, V> the entry in the cache node) Schedules a timer event for the node.
pack-priv void	unlink(Node<K, V> node) Removes the entry from its bucket, if scheduled.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BUCKETS	back to summary
pack-priv static final int[] BUCKETS

nanos	back to summary
pack-priv long nanos

SHIFT	back to summary
pack-priv static final long[] SHIFT

SPANS	back to summary
pack-priv static final long[] SPANS

wheel	back to summary
pack-priv final Node<K, V>[][] wheel

Constructor Detail

TimerWheel	back to summary
pack-priv TimerWheel() Annotations @SuppressWarnings:rawtypes, unchecked

Method Detail

advance	back to summary
public void advance(BoundedLocalCache<K, V> cache, long currentTimeNanos) Advances the timer and evicts entries that have expired. Parameters cache:BoundedLocalCache<K, V> the instance that the entries belong to currentTimeNanos:long the current time, in nanoseconds Annotations @SuppressWarnings:PMD.UnusedAssignment

advance

back to summary

public void advance(BoundedLocalCache<K, V> cache, long currentTimeNanos)

Advances the timer and evicts entries that have expired.

Parameters

cache:BoundedLocalCache<K, V>: the instance that the entries belong to
currentTimeNanos:long: the current time, in nanoseconds

Annotations

@SuppressWarnings:PMD.UnusedAssignment

descendingIterator	back to summary
public Iterator<Node<K, V>> descendingIterator() Returns an iterator roughly ordered by the expiration time from the entries least likely to expire (youngest) to the entries most likely to expire (oldest). The wheels are evaluated in order, but the timers that fall within the bucket's range are not sorted.

deschedule	back to summary
public void deschedule(Node<K, V> node) Removes a timer event for this entry if present. Parameters node:Node<K, V> the entry in the cache

deschedule

back to summary

public void deschedule(Node<K, V> node)

Removes a timer event for this entry if present.

Parameters

node:Node<K, V>: the entry in the cache

expire	back to summary
pack-priv void expire(BoundedLocalCache<K, V> cache, int index, long previousTicks, long delta) Expires entries or reschedules into the proper bucket if still active. Parameters cache:BoundedLocalCache<K, V> the instance that the entries belong to index:int the timing wheel being operated on previousTicks:long the previous number of ticks delta:long the number of additional ticks

expire

back to summary

pack-priv void expire(BoundedLocalCache<K, V> cache, int index, long previousTicks, long delta)

Expires entries or reschedules into the proper bucket if still active.

Parameters

cache:BoundedLocalCache<K, V>: the instance that the entries belong to
index:int: the timing wheel being operated on
previousTicks:long: the previous number of ticks
delta:long: the number of additional ticks

findBucket	back to summary
pack-priv Node<K, V> findBucket(long time) Determines the bucket that the timer event should be added to. Parameters time:long the time when the event fires Returns:Node<K, V> the sentinel at the head of the bucket

findBucket

back to summary

pack-priv Node<K, V> findBucket(long time)

Determines the bucket that the timer event should be added to.

Parameters

time:long: the time when the event fires

Returns:Node<K, V>

the sentinel at the head of the bucket

getExpirationDelay back to summary

getExpirationDelay	back to summary
public long getExpirationDelay() Returns the duration until the next bucket expires, or `Long#MAX_VALUE` if none. Annotations @SuppressWarnings:IntLongMath

public long getExpirationDelay()

Returns the duration until the next bucket expires, or Long#MAX_VALUE if none.

Annotations

@SuppressWarnings:IntLongMath

iterator	back to summary
public Iterator<Node<K, V>> iterator() Implements java.lang.Iterable.iterator. Returns an iterator roughly ordered by the expiration time from the entries most likely to expire (oldest) to the entries least likely to expire (youngest). The wheels are evaluated in order, but the timers that fall within the bucket's range are not sorted. Returns:Iterator<Node<K, V>> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override

iterator

back to summary

public Iterator<Node<K, V>> iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator roughly ordered by the expiration time from the entries most likely to expire (oldest) to the entries least likely to expire (youngest). The wheels are evaluated in order, but the timers that fall within the bucket's range are not sorted.

Returns:Iterator<Node<K, V>>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

link	back to summary
pack-priv void link(Node<K, V> sentinel, Node<K, V> node) Adds the entry at the tail of the bucket's list.

peekAhead back to summary

peekAhead	back to summary
pack-priv long peekAhead(int index) Returns the duration when the wheel's next bucket expires, or `Long#MAX_VALUE` if empty. Parameters index:int the timing wheel being operated on

pack-priv long peekAhead(int index)

Returns the duration when the wheel's next bucket expires, or Long#MAX_VALUE if empty.

Parameters

index:int: the timing wheel being operated on

reschedule	back to summary
public void reschedule(Node<K, V> node) Reschedules an active timer event for the node. Parameters node:Node<K, V> the entry in the cache

reschedule

back to summary

public void reschedule(Node<K, V> node)

Reschedules an active timer event for the node.

Parameters

node:Node<K, V>: the entry in the cache

schedule	back to summary
public void schedule(Node<K, V> node) Schedules a timer event for the node. Parameters node:Node<K, V> the entry in the cache

schedule

back to summary

public void schedule(Node<K, V> node)

Schedules a timer event for the node.

Parameters

node:Node<K, V>: the entry in the cache

unlink	back to summary
pack-priv void unlink(Node<K, V> node) Removes the entry from its bucket, if scheduled.

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class TimerWheel.AscendingIterator

Class Inheritance

extends TimerWheel<K, V>.Traverser

java.lang.Object
com.github.benmanes.caffeine.cache.TimerWheel.Traverser
com.github.benmanes.caffeine.cache.TimerWheel.AscendingIterator

Field Summary

Modifier and Type	Field and Description
pack-priv int	steps
pack-priv int	wheelIndex

Inherited from com.github.benmanes.caffeine.cache.TimerWheel.Traverser:: current expectedNanos next

Constructor Summary

Access	Constructor and Description
pack-priv	AscendingIterator()

Method Summary

Modifier and Type	Method and Description
pack-priv int	bucketIndex()
pack-priv @Nullable Node<K, V>	goToNextBucket() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket. Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted.
pack-priv @Nullable Node<K, V>	goToNextWheel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel. Returns the sentinel for the next wheel's bucket position, or null if no more wheels.
pack-priv boolean	isDone() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone. Returns if the iteration has completed.
pack-priv Node<K, V>	sentinel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel. Returns the sentinel at the current wheel and bucket position.
pack-priv Node<K, V>	traverse(Node<K, V> node) Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse. Returns the node's successor, or the bucket's sentinel if at the end.

Inherited from com.github.benmanes.caffeine.cache.TimerWheel.Traverser:: computeNext hasNext next

Field Detail

steps	back to summary
pack-priv int steps

wheelIndex	back to summary
pack-priv int wheelIndex

Constructor Detail

AscendingIterator	back to summary
pack-priv AscendingIterator()

Method Detail

bucketIndex	back to summary
pack-priv int bucketIndex()

goToNextBucket	back to summary
pack-priv @Nullable Node<K, V> goToNextBucket() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket. Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted. Annotations @Override

goToNextBucket

back to summary

pack-priv @Nullable Node<K, V> goToNextBucket()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket.

Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted.

Annotations

@Override

goToNextWheel	back to summary
pack-priv @Nullable Node<K, V> goToNextWheel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel. Returns the sentinel for the next wheel's bucket position, or null if no more wheels. Annotations @Override

goToNextWheel

back to summary

pack-priv @Nullable Node<K, V> goToNextWheel()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel.

Returns the sentinel for the next wheel's bucket position, or null if no more wheels.

Annotations

@Override

isDone	back to summary
pack-priv boolean isDone() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone. Returns if the iteration has completed. Annotations @Override

isDone

back to summary

pack-priv boolean isDone()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone.

Returns if the iteration has completed.

Annotations

@Override

sentinel	back to summary
pack-priv Node<K, V> sentinel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel. Returns the sentinel at the current wheel and bucket position. Annotations @Override

sentinel

back to summary

pack-priv Node<K, V> sentinel()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel.

Returns the sentinel at the current wheel and bucket position.

Annotations

@Override

traverse	back to summary
pack-priv Node<K, V> traverse(Node<K, V> node) Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse. Returns the node's successor, or the bucket's sentinel if at the end. Annotations @Override

traverse

back to summary

pack-priv Node<K, V> traverse(Node<K, V> node)

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse.

Returns the node's successor, or the bucket's sentinel if at the end.

Annotations

@Override

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class TimerWheel.DescendingIterator

Class Inheritance

extends TimerWheel<K, V>.Traverser

java.lang.Object
com.github.benmanes.caffeine.cache.TimerWheel.Traverser
com.github.benmanes.caffeine.cache.TimerWheel.DescendingIterator

Field Summary

Modifier and Type	Field and Description
pack-priv int	steps
pack-priv int	wheelIndex

Inherited from com.github.benmanes.caffeine.cache.TimerWheel.Traverser:: current expectedNanos next

Constructor Summary

Access	Constructor and Description
pack-priv	DescendingIterator()

Method Summary

Modifier and Type	Method and Description
pack-priv int	bucketIndex()
pack-priv @Nullable Node<K, V>	goToNextBucket() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket. Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted.
pack-priv @Nullable Node<K, V>	goToNextWheel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel. Returns the sentinel for the next wheel's bucket position, or null if no more wheels.
pack-priv boolean	isDone() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone. Returns if the iteration has completed.
pack-priv Node<K, V>	sentinel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel. Returns the sentinel at the current wheel and bucket position.
pack-priv Node<K, V>	traverse(Node<K, V> node) Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse. Returns the node's successor, or the bucket's sentinel if at the end.

Inherited from com.github.benmanes.caffeine.cache.TimerWheel.Traverser:: computeNext hasNext next

Field Detail

steps	back to summary
pack-priv int steps

wheelIndex	back to summary
pack-priv int wheelIndex

Constructor Detail

DescendingIterator	back to summary
pack-priv DescendingIterator()

Method Detail

bucketIndex	back to summary
pack-priv int bucketIndex()

goToNextBucket	back to summary
pack-priv @Nullable Node<K, V> goToNextBucket() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket. Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted. Annotations @Override

goToNextBucket

back to summary

pack-priv @Nullable Node<K, V> goToNextBucket()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextBucket.

Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted.

Annotations

@Override

goToNextWheel	back to summary
pack-priv @Nullable Node<K, V> goToNextWheel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel. Returns the sentinel for the next wheel's bucket position, or null if no more wheels. Annotations @Override

goToNextWheel

back to summary

pack-priv @Nullable Node<K, V> goToNextWheel()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.goToNextWheel.

Returns the sentinel for the next wheel's bucket position, or null if no more wheels.

Annotations

@Override

isDone	back to summary
pack-priv boolean isDone() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone. Returns if the iteration has completed. Annotations @Override

isDone

back to summary

pack-priv boolean isDone()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.isDone.

Returns if the iteration has completed.

Annotations

@Override

sentinel	back to summary
pack-priv Node<K, V> sentinel() Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel. Returns the sentinel at the current wheel and bucket position. Annotations @Override

sentinel

back to summary

pack-priv Node<K, V> sentinel()

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.sentinel.

Returns the sentinel at the current wheel and bucket position.

Annotations

@Override

traverse	back to summary
pack-priv Node<K, V> traverse(Node<K, V> node) Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse. Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse. Returns the node's successor, or the bucket's sentinel if at the end. Annotations @Override

traverse

back to summary

pack-priv Node<K, V> traverse(Node<K, V> node)

Implements abstract com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse.

Doc from com.github.benmanes.caffeine.cache.TimerWheel.Traverser.traverse.

Returns the node's successor, or the bucket's sentinel if at the end.

Annotations

@Override

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class TimerWheel.Sentinel<K, V>

Class Inheritance

extends Node<K, V>

java.lang.Object
com.github.benmanes.caffeine.cache.Node
com.github.benmanes.caffeine.cache.TimerWheel.Sentinel

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

Field Summary

Modifier and Type	Field and Description
pack-priv Node<K, V>	next
pack-priv Node<K, V>	prev

Inherited from com.github.benmanes.caffeine.cache.Node:: PROBATION PROTECTED WINDOW

Constructor Summary

Access	Constructor and Description
pack-priv	Sentinel()

Method Summary

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

Field Detail

next	back to summary
pack-priv Node<K, V> next

prev	back to summary
pack-priv Node<K, V> prev

Constructor Detail

Sentinel	back to summary
pack-priv Sentinel()

Method Detail

containsValue back to summary

public boolean containsValue(Object value)

Implements abstract com.github.benmanes.caffeine.cache.Node.containsValue.

Doc from com.github.benmanes.caffeine.cache.Node.containsValue.

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.

Annotations

@Override

die back to summary

public void die()

Implements abstract com.github.benmanes.caffeine.cache.Node.die.

Doc from com.github.benmanes.caffeine.cache.Node.die.

Sets the node to the dead state.

Annotations

@Override

getKey back to summary

public @Nullable K getKey()

Implements abstract com.github.benmanes.caffeine.cache.Node.getKey.

Doc from com.github.benmanes.caffeine.cache.Node.getKey.

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

Annotations

@Override

getKeyReference back to summary

public Object getKeyReference()

Implements abstract com.github.benmanes.caffeine.cache.Node.getKeyReference.

Doc from com.github.benmanes.caffeine.cache.Node.getKeyReference.

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

Annotations

@Override

getNextInVariableOrder

back to summary

public Node<K, V> getNextInVariableOrder()

Overrides com.github.benmanes.caffeine.cache.Node.getNextInVariableOrder.

Annotations

@Override

getPreviousInVariableOrder

back to summary

public Node<K, V> getPreviousInVariableOrder()

Overrides com.github.benmanes.caffeine.cache.Node.getPreviousInVariableOrder.

Annotations

@Override

getValue back to summary

public @Nullable V getValue()

Implements abstract com.github.benmanes.caffeine.cache.Node.getValue.

Doc from com.github.benmanes.caffeine.cache.Node.getValue.

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

Annotations

@Override

getValueReference back to summary

public Object getValueReference()

Implements abstract com.github.benmanes.caffeine.cache.Node.getValueReference.

Doc from com.github.benmanes.caffeine.cache.Node.getValueReference.

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

Annotations

@Override

isAlive

back to summary

public boolean isAlive()

Implements abstract com.github.benmanes.caffeine.cache.Node.isAlive.

Doc from com.github.benmanes.caffeine.cache.Node.isAlive.

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

Annotations

@Override

isDead

back to summary

public boolean isDead()

Implements abstract com.github.benmanes.caffeine.cache.Node.isDead.

Doc from com.github.benmanes.caffeine.cache.Node.isDead.

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

Annotations

@Override

isRetired

back to summary

public boolean isRetired()

Implements abstract com.github.benmanes.caffeine.cache.Node.isRetired.

Doc from com.github.benmanes.caffeine.cache.Node.isRetired.

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

Annotations

@Override

retire back to summary

public void retire()

Implements abstract com.github.benmanes.caffeine.cache.Node.retire.

Doc from com.github.benmanes.caffeine.cache.Node.retire.

Sets the node to the retired state.

Annotations

@Override

setNextInVariableOrder	back to summary
public void setNextInVariableOrder(@Nullable Node<K, V> next) Annotations @SuppressWarnings:NullAway @Override

setPreviousInVariableOrder	back to summary
public void setPreviousInVariableOrder(@Nullable Node<K, V> prev) Annotations @SuppressWarnings:NullAway @Override

setValue	back to summary
public void setValue(V value, @Nullable ReferenceQueue<V> referenceQueue) Annotations @Override

com.github.benmanes.caffeine.cache back to summary

pack-priv abstract Class TimerWheel.Traverser

Class Inheritance

extends Object
implements Iterator<Node<K, V>>

java.lang.Object
com.github.benmanes.caffeine.cache.TimerWheel.Traverser

All Implemented Interfaces

java.util.Iterator

Known Direct Subclasses

com.github.benmanes.caffeine.cache.TimerWheel.AscendingIterator, com.github.benmanes.caffeine.cache.TimerWheel.DescendingIterator

An iterator with rough ordering that can be specialized for either direction.

Field Summary

Modifier and Type	Field and Description
pack-priv @Nullable Node<K, V>	current
pack-priv final long	expectedNanos
pack-priv @Nullable Node<K, V>	next

Constructor Summary

Access	Constructor and Description
pack-priv	Traverser()

Method Summary

Modifier and Type	Method and Description
pack-priv @Nullable Node<K, V>	computeNext()
pack-priv abstract @Nullable Node<K, V>	goToNextBucket() Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted.
pack-priv abstract @Nullable Node<K, V>	goToNextWheel() Returns the sentinel for the next wheel's bucket position, or null if no more wheels.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
pack-priv abstract boolean	isDone() Returns if the iteration has completed.
public Node<K, V>	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
pack-priv abstract Node<K, V>	sentinel() Returns the sentinel at the current wheel and bucket position.
pack-priv abstract Node<K, V>	traverse(Node<K, V> node) Returns the node's successor, or the bucket's sentinel if at the end.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

current	back to summary
pack-priv @Nullable Node<K, V> current

expectedNanos	back to summary
pack-priv final long expectedNanos

next	back to summary
pack-priv @Nullable Node<K, V> next

Constructor Detail

Traverser	back to summary
pack-priv Traverser()

Method Detail

computeNext	back to summary
pack-priv @Nullable Node<K, V> computeNext()

goToNextBucket	back to summary
pack-priv abstract @Nullable Node<K, V> goToNextBucket() Returns the sentinel for the wheel's next bucket, or null if the wheel is exhausted.

goToNextWheel	back to summary
pack-priv abstract @Nullable Node<K, V> goToNextWheel() Returns the sentinel for the next wheel's bucket position, or null if no more wheels.

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

isDone	back to summary
pack-priv abstract boolean isDone() Returns if the iteration has completed.

back to summary

public Node<K, V> next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Node<K, V>

the next element in the iteration

Annotations

@Override
@SuppressWarnings:NullAway

sentinel	back to summary
pack-priv abstract Node<K, V> sentinel() Returns the sentinel at the current wheel and bucket position.

traverse	back to summary
pack-priv abstract Node<K, V> traverse(Node<K, V> node) Returns the node's successor, or the bucket's sentinel if at the end.

pack-priv final Class TimerWheel<K, V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class TimerWheel.AscendingIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class TimerWheel.DescendingIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class TimerWheel.Sentinel<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class TimerWheel.Traverser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail