Progress (cache2k implementation 1.2.2.Final API)

All Known Implementing Classes:

EntryAction
```
public interface Progress<K,V,R>
```
Interface for cache operation semantics to control the progress of the processing.

Author:

Jens Wilke

See Also:

Semantic

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`entryResult(ExaminationEntry e)` Returns a cache entry as result.
`void`	`expire(long expiryTime)` Reset expiry to the specified value.
`void`	`failure(RuntimeException t)` Bad things happened, propagate the exception to the client.
`long`	`getCurrentTime()` The current time in millis or the value when it was first called.
`boolean`	`isPresent()` Entry has valid data in the cache and is not expired.
`boolean`	`isPresentOrInRefreshProbation()` Same as `isPresent()` but also true if the entry is in refresh probation.
`boolean`	`isPresentOrMiss()` Entry has valid data in the cache and is not expired.
`void`	`load()` Request that the entry value gets loaded from loader.
`void`	`loadAndMutation()` Request a load, however call update again for the final outcome.
`RuntimeException`	`propagateException(K key, org.cache2k.integration.ExceptionInformation inf)` Needed for the mutable entry getValue() to throw an exception.
`void`	`put(V value)` Update the entry with the new value.
`void`	`putAndSetExpiry(V value, long expiryTime, long refreshTime)` Set new value, skip expiry calculation and set expiry time directly.
`void`	`refresh()` Same as load but counting statistics as refresh.
`void`	`remove()` The entry will be removed.
`void`	`result(R result)` Sets the operation result.
`void`	`wantData()` Requests that the cache content for an entry will be provided.
`void`	`wantMutation()` The entry gets locked for mutation.

- Method Detail
  - getCurrentTime
```
long getCurrentTime()
```
    The current time in millis or the value when it was first called.
  - wantData
```
void wantData()
```
    Requests that the cache content for an entry will be provided. If the cache is tiered, the data will be read into the heap cache. Last command of semantic method. Calls back on Semantic.examine(Progress, ExaminationEntry)
  - isPresent
```
boolean isPresent()
```
    Entry has valid data in the cache and is not expired. This is used for operations that do not want to access the value.
  - isPresentOrInRefreshProbation
```
boolean isPresentOrInRefreshProbation()
```
    Same as isPresent() but also true if the entry is in refresh probation.
  - isPresentOrMiss
```
boolean isPresentOrMiss()
```
    Entry has valid data in the cache and is not expired. Counts a miss, if no entry is available, this is used for operations that do want to access the value.
  - wantMutation
```
void wantMutation()
```
    The entry gets locked for mutation. Last command of semantic method. Calls back on Semantic.update(Progress, ExaminationEntry)
  - result
```
void result(R result)
```
    Sets the operation result.
  - entryResult
```
void entryResult(ExaminationEntry e)
```
    Returns a cache entry as result. The entry will be copied before returning.
  - propagateException
```
RuntimeException propagateException(K key,
                                    org.cache2k.integration.ExceptionInformation inf)
```
    Needed for the mutable entry getValue() to throw an exception.
  - load
```
void load()
```
    Request that the entry value gets loaded from loader. Last command of semantic method. By default the loaded value will be set as operation result. Defined in Semantic.Base
  - refresh
```
void refresh()
```
    Same as load but counting statistics as refresh.
  - loadAndMutation
```
void loadAndMutation()
```
    Request a load, however call update again for the final outcome.
  - expire
```
void expire(long expiryTime)
```
    Reset expiry to the specified value. Don't change the value.
  - remove
```
void remove()
```
    The entry will be removed. Last command of semantic method.
  - put
```
void put(V value)
```
    Update the entry with the new value. Last command of semantic method.
  - failure
```
void failure(RuntimeException t)
```
    Bad things happened, propagate the exception to the client. The original exception must be wrapped. The calling stacktrace will be filled into the wrapped exception before thrown.
  - putAndSetExpiry
```
void putAndSetExpiry(V value,
                     long expiryTime,
                     long refreshTime)
```
    Set new value, skip expiry calculation and set expiry time directly.

Interface Progress<K,V,R>

Method Summary

Method Detail

getCurrentTime

wantData

isPresent

isPresentOrInRefreshProbation

isPresentOrMiss

wantMutation

result

entryResult

propagateException

load

refresh

loadAndMutation

expire

remove

put

failure

putAndSetExpiry