org.archive.util

Interface ObjectIdentityCache<V extends IdentityCacheable>

Type Parameters:

V -

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ObjectIdentityBdbCache, ObjectIdentityBdbManualCache, ObjectIdentityMemCache

public interface ObjectIdentityCache<V extends IdentityCacheable>
extends Closeable

An object cache for create-once-by-name-and-then-reuse objects. Objects are added, but never removed. Subsequent get()s using the same key will return the exact same object, UNLESS all such objects have been forgotten, in which case a new object MAY be returned. This allows implementors (such as ObjectIdentityBdbCache or CachedBdbMap) to page out (aka 'expunge') instances to persistent storage while they're not being used. However, as long as they are used (referenced), all requests for the same-named object will share a reference to the same object, and the object may be mutated in place without concern for explicitly persisting its state to disk.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close/release any associated resources
void	dirtyKey(String key) force the persistent backend, if any, to eventually be updated with live object state for the given key
V	get(String key) get the object under the given key/name -- but should not mutate object state
V	getOrUse(String key, Supplier<V> supplierOrNull) get the object under the given key/name, using (and remembering) the object supplied by the supplier if no prior mapping exists -- but should not mutate object state
Set<String>	keySet() set of all keys
int	size() count of name-to-object contained
void	sync() force the persistent backend, if any, to be updated with all live object state

Method Detail

get

V get(String key)

get the object under the given key/name -- but should not mutate object state

getOrUse

V getOrUse(String key,
         Supplier<V> supplierOrNull)

get the object under the given key/name, using (and remembering) the object supplied by the supplier if no prior mapping exists -- but should not mutate object state

sync

void sync()

force the persistent backend, if any, to be updated with all live object state

dirtyKey

void dirtyKey(String key)

force the persistent backend, if any, to eventually be updated with live object state for the given key

close

void close()

close/release any associated resources

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

size

int size()

count of name-to-object contained

keySet

Set<String> keySet()

set of all keys