Package org.cache2k.core.operation

Interface Semantic<K,V,R>

All Known Implementing Classes:

Operations.ExpireEvent, Semantic.Base, Semantic.InsertOrUpdate, Semantic.MightUpdate, Semantic.Read, Semantic.Update

public interface Semantic<K,V,R>

Defines the semantic of a cache operation based on Java code that examines the cached entry and calls Progress for instructing the cache what needs to be done.

Author:

Jens Wilke

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Semantic.Base<K,V,R>	Base class to provide a default for the load result.
static class	Semantic.InsertOrUpdate<K,V,R>	Only update the entry.
static class	Semantic.MightUpdate<K,V,R>	Read a cache entry and do an optional mutation.
static class	Semantic.Read<K,V,R>	Read only operation.
static class	Semantic.Update<K,V,R>	Read a cache entry and do an mutation maybe based on the existing values.

Method Summary

Modifier and Type	Method	Description
void	examine(K key, Progress<K,V,R> c, ExaminationEntry<K,V> e)	Called with the entry containing the recent content.
void	loaded(K key, Progress<K,V,R> c, ExaminationEntry<K,V> e)	Load is complete.
void	mutate(K key, Progress<K,V,R> c, ExaminationEntry<K,V> e)	Perform the mutation.
void	start(K key, Progress<K,V,R> c)	Start of the operation.

Method Detail

start

void start(K key,
           Progress<K,V,R> c)

Start of the operation. Either calls Progress.wantData() or Progress.wantMutation(). A Progress.wantMutation() at the start means we don't need the current data and will mutate the entry unconditionally.

examine

void examine(K key,
             Progress<K,V,R> c,
             ExaminationEntry<K,V> e)

Called with the entry containing the recent content. If this method finishes with Progress.wantMutation() it will be called again after the entry is locked for mutation to reevaluate the examination after concurrent operations on the same entry have completed.

mutate

void mutate(K key,
            Progress<K,V,R> c,
            ExaminationEntry<K,V> e)

Perform the mutation. The mutation is done by calling the methods on Progress.

loaded

void loaded(K key,
            Progress<K,V,R> c,
            ExaminationEntry<K,V> e)

Load is complete.