Caffeine cache 3.1.8 · com.github.benmanes.caffeine.cache.Node

Modifier and Type	Field and Description
public static final int	PROBATION
public static final int	PROTECTED
public static final int	WINDOW

Access	Constructor and Description
pack-priv	Node()

Method Summary

Modifier and Type	Method and Description
public boolean	casVariableTime(long expect, long update) Atomically sets the variable time to the given updated value if the current value equals the expected value and returns if the update was successful.
public boolean	casWriteTime(long expect, long update) Atomically sets the write-time to the given updated value if the current value equals the expected value and returns if the update was successful.
public abstract boolean	containsValue(Object value) Returns `true` if the given objects are considered equivalent.
public abstract void	die() Sets the node to the `dead` state.
public long	getAccessTime() Returns the time that this entry was last accessed, in ns.
public abstract @Nullable K	getKey() Return the key or `null` if it has been reclaimed by the garbage collector.
public abstract Object	getKeyReference() Returns the reference that the cache is holding the entry by.
public @Nullable Node<K, V>	getNextInAccessOrder() Implements com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getNextInAccessOrder. Retrieves the next element or `null` if either the element is unlinked or the last element on the deque.
public Node<K, V>	getNextInVariableOrder()
public @Nullable Node<K, V>	getNextInWriteOrder() Implements com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getNextInWriteOrder. Retrieves the next element or `null` if either the element is unlinked or the last element on the deque.
public @NonNegative int	getPolicyWeight() Returns the weight of this entry from the policy's perspective.
public @Nullable Node<K, V>	getPreviousInAccessOrder() Implements com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getPreviousInAccessOrder. Retrieves the previous element or `null` if either the element is unlinked or the first element on the deque.
public Node<K, V>	getPreviousInVariableOrder()
public @Nullable Node<K, V>	getPreviousInWriteOrder() Implements com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getPreviousInWriteOrder. Retrieves the previous element or `null` if either the element is unlinked or the first element on the deque.
public int	getQueueType() Returns the queue that the entry's resides in (window, probation, or protected).
public abstract @Nullable V	getValue() Return the value or `null` if it has been reclaimed by the garbage collector.
public abstract Object	getValueReference() Returns the reference to the value.
public long	getVariableTime() Returns the variable expiration time, in nanoseconds.
public @NonNegative int	getWeight() Returns the weight of this entry from the entry's perspective.
public long	getWriteTime() Returns the time that this entry was last written, in ns.
public boolean	inMainProbation() Returns if the entry is in the Main space's probation queue.
public boolean	inMainProtected() Returns if the entry is in the Main space's protected queue.
public boolean	inWindow() Returns if the entry is in the Window or Main space.
public abstract boolean	isAlive() If the entry is available in the hash-table and page replacement policy.
public abstract boolean	isDead() If the entry was removed from the hash-table and the page replacement policy.
public abstract boolean	isRetired() If the entry was removed from the hash-table and is awaiting removal from the page replacement policy.
public void	makeMainProbation() Sets the status to the Main space's probation queue.
public void	makeMainProtected() Sets the status to the Main space's protected queue.
public void	makeWindow() Sets the status to the Window queue.
public abstract void	retire() Sets the node to the `retired` state.
public void	setAccessTime(long time) Sets the access time in nanoseconds.
public void	setNextInAccessOrder(@Nullable Node<K, V> next)
public void	setNextInVariableOrder(@Nullable Node<K, V> prev)
public void	setNextInWriteOrder(@Nullable Node<K, V> next)
public void	setPolicyWeight(@NonNegative int weight) Sets the weight from the policy's perspective.
public void	setPreviousInAccessOrder(@Nullable Node<K, V> prev)
public void	setPreviousInVariableOrder(@Nullable Node<K, V> prev)
public void	setPreviousInWriteOrder(@Nullable Node<K, V> prev)
public void	setQueueType(int queueType) Set queue that the entry resides in (window, probation, or protected).
public abstract void	setValue(V value, @Nullable ReferenceQueue<V> referenceQueue) Sets the value, which may be held strongly, weakly, or softly.
public void	setVariableTime(long time) Sets the variable expiration time in nanoseconds.
public void	setWeight(@NonNegative int weight) Sets the weight from the entry's perspective.
public void	setWriteTime(long time) Sets the write-time in nanoseconds.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

PROBATION	back to summary
public static final int PROBATION

PROTECTED	back to summary
public static final int PROTECTED

WINDOW	back to summary
public static final int WINDOW

Node	back to summary
pack-priv Node()

Method Detail

casVariableTime	back to summary
public boolean casVariableTime(long expect, long update) Atomically sets the variable time to the given updated value if the current value equals the expected value and returns if the update was successful.

casWriteTime	back to summary
public boolean casWriteTime(long expect, long update) Atomically sets the write-time to the given updated value if the current value equals the expected value and returns if the update was successful.

containsValue	back to summary
public abstract boolean containsValue(Object value) 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.

die back to summary

die	back to summary
public abstract void die() Sets the node to the `dead` state. Annotations @GuardedBy:this

public abstract void die()

Sets the node to the dead state.

Annotations

@GuardedBy:this

getAccessTime	back to summary
public long getAccessTime() Returns the time that this entry was last accessed, in ns.

getKey	back to summary
public abstract @Nullable K getKey() Return the key or `null` if it has been reclaimed by the garbage collector.

getKeyReference	back to summary
public abstract Object 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.

getNextInAccessOrder back to summary

getNextInAccessOrder	back to summary
public @Nullable Node<K, V> getNextInAccessOrder() Implements com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getNextInAccessOrder. Doc from com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getNextInAccessOrder. Retrieves the next element or `null` if either the element is unlinked or the last element on the deque. Annotations @Override

public @Nullable Node<K, V> getNextInAccessOrder()

Implements com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getNextInAccessOrder.

Doc from com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getNextInAccessOrder.

Retrieves the next element or null if either the element is unlinked or the last element on the deque.

Annotations

@Override

getNextInVariableOrder	back to summary
public Node<K, V> getNextInVariableOrder()

getNextInWriteOrder back to summary

getNextInWriteOrder	back to summary
public @Nullable Node<K, V> getNextInWriteOrder() Implements com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getNextInWriteOrder. Doc from com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getNextInWriteOrder. Retrieves the next element or `null` if either the element is unlinked or the last element on the deque. Annotations @Override

public @Nullable Node<K, V> getNextInWriteOrder()

Implements com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getNextInWriteOrder.

Doc from com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getNextInWriteOrder.

Retrieves the next element or null if either the element is unlinked or the last element on the deque.

Annotations

@Override

getPolicyWeight	back to summary
public @NonNegative int getPolicyWeight() Returns the weight of this entry from the policy's perspective.

getPreviousInAccessOrder back to summary

getPreviousInAccessOrder	back to summary
public @Nullable Node<K, V> getPreviousInAccessOrder() Implements com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getPreviousInAccessOrder. Doc from com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getPreviousInAccessOrder. Retrieves the previous element or `null` if either the element is unlinked or the first element on the deque. Annotations @Override

public @Nullable Node<K, V> getPreviousInAccessOrder()

Implements com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getPreviousInAccessOrder.

Doc from com.github.benmanes.caffeine.cache.AccessOrderDeque.AccessOrder.getPreviousInAccessOrder.

Retrieves the previous element or null if either the element is unlinked or the first element on the deque.

Annotations

@Override

getPreviousInVariableOrder	back to summary
public Node<K, V> getPreviousInVariableOrder()

getPreviousInWriteOrder back to summary

getPreviousInWriteOrder	back to summary
public @Nullable Node<K, V> getPreviousInWriteOrder() Implements com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getPreviousInWriteOrder. Doc from com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getPreviousInWriteOrder. Retrieves the previous element or `null` if either the element is unlinked or the first element on the deque. Annotations @Override

public @Nullable Node<K, V> getPreviousInWriteOrder()

Implements com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getPreviousInWriteOrder.

Doc from com.github.benmanes.caffeine.cache.WriteOrderDeque.WriteOrder.getPreviousInWriteOrder.

Retrieves the previous element or null if either the element is unlinked or the first element on the deque.

Annotations

@Override

getQueueType	back to summary
public int getQueueType() Returns the queue that the entry's resides in (window, probation, or protected).

getValue	back to summary
public abstract @Nullable V getValue() Return the value or `null` if it has been reclaimed by the garbage collector.

getValueReference	back to summary
public abstract Object getValueReference() Returns the reference to the value. This is either the value if strongly held or a `java.lang.ref.Reference` to that value.

getVariableTime	back to summary
public long getVariableTime() Returns the variable expiration time, in nanoseconds.

getWeight	back to summary
public @NonNegative int getWeight() Returns the weight of this entry from the entry's perspective. Annotations @GuardedBy:this

getWeight

back to summary

public @NonNegative int getWeight()

Returns the weight of this entry from the entry's perspective.

Annotations

@GuardedBy:this

getWriteTime	back to summary
public long getWriteTime() Returns the time that this entry was last written, in ns.

inMainProbation	back to summary
public boolean inMainProbation() Returns if the entry is in the Main space's probation queue.

inMainProtected	back to summary
public boolean inMainProtected() Returns if the entry is in the Main space's protected queue.

inWindow	back to summary
public boolean inWindow() Returns if the entry is in the Window or Main space.

isAlive	back to summary
public abstract boolean isAlive() If the entry is available in the hash-table and page replacement policy.

isDead	back to summary
public abstract boolean isDead() If the entry was removed from the hash-table and the page replacement policy. Annotations @GuardedBy:this

isDead

back to summary

public abstract boolean isDead()

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

Annotations

@GuardedBy:this

isRetired	back to summary
public abstract boolean isRetired() If the entry was removed from the hash-table and is awaiting removal from the page replacement policy. Annotations @GuardedBy:this

isRetired

back to summary

public abstract boolean isRetired()

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

Annotations

@GuardedBy:this

makeMainProbation	back to summary
public void makeMainProbation() Sets the status to the Main space's probation queue.

makeMainProtected	back to summary
public void makeMainProtected() Sets the status to the Main space's protected queue.

makeWindow	back to summary
public void makeWindow() Sets the status to the Window queue.

retire back to summary

retire	back to summary
public abstract void retire() Sets the node to the `retired` state. Annotations @GuardedBy:this

public abstract void retire()

Sets the node to the retired state.

Annotations

@GuardedBy:this

setAccessTime	back to summary
public void setAccessTime(long time) Sets the access time in nanoseconds. This update may be set lazily and rely on the memory fence when the lock is released.

setNextInAccessOrder	back to summary
public void setNextInAccessOrder(@Nullable Node<K, V> next) Annotations @Override

setNextInVariableOrder	back to summary
public void setNextInVariableOrder(@Nullable Node<K, V> prev)

setNextInWriteOrder	back to summary
public void setNextInWriteOrder(@Nullable Node<K, V> next) Annotations @Override

setPolicyWeight	back to summary
public void setPolicyWeight(@NonNegative int weight) Sets the weight from the policy's perspective.

setPreviousInAccessOrder	back to summary
public void setPreviousInAccessOrder(@Nullable Node<K, V> prev) Annotations @Override

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

setPreviousInWriteOrder	back to summary
public void setPreviousInWriteOrder(@Nullable Node<K, V> prev) Annotations @Override

setQueueType	back to summary
public void setQueueType(int queueType) Set queue that the entry resides in (window, probation, or protected).

setValue	back to summary
public abstract void setValue(V value, @Nullable ReferenceQueue<V> referenceQueue) Sets the value, which may be held strongly, weakly, or softly. Annotations @GuardedBy:this

setValue

back to summary

public abstract void setValue(V value, @Nullable ReferenceQueue<V> referenceQueue)

Sets the value, which may be held strongly, weakly, or softly.

Annotations

@GuardedBy:this

setVariableTime	back to summary
public void setVariableTime(long time) Sets the variable expiration time in nanoseconds. This update may be set lazily and rely on the memory fence when the lock is released.

setWeight	back to summary
public void setWeight(@NonNegative int weight) Sets the weight from the entry's perspective. Annotations @GuardedBy:this

setWeight

back to summary

public void setWeight(@NonNegative int weight)

Sets the weight from the entry's perspective.

Annotations

@GuardedBy:this

setWriteTime	back to summary
public void setWriteTime(long time) Sets the write-time in nanoseconds. This update may be set lazily and rely on the memory fence when the lock is released.

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override
@SuppressWarnings:GuardedBy

pack-priv abstract Class Node<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail