com.tangosol.io

Interface BinaryStore

All Known Subinterfaces:

BinaryStore.KeySetAware, BinaryStore.SizeAware

All Known Implementing Classes:

AbstractBinaryStore, AsyncBinaryStore, BerkeleyDBBinaryStore, BinaryMapStore, JournalBinaryStore, SerializationPagedCache.FakeBinaryStore, SerializationPagedCache.PagedBinaryStore, SerializationPagedCache.WrapperBinaryStore

public interface BinaryStore

A simple mapping of CacheStore operations for Binary objects into a Java interface.

Since:

Coherence 2.2

Author:

cp 2003.05.26

See Also:

CacheStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BinaryStore.KeySetAware If a BinaryStore is aware of which keys that it stores, then it should implement this optional interface in order to allow that information to be efficiently communicated to an intelligent consumer of the BinaryStore interface.
static interface	BinaryStore.SizeAware If a BinaryStore is aware of the number of keys that it stores, then it should implement this optional interface in order to allow that information to be efficiently communicated to an intelligent consumer of the BinaryStore interface.

Method Summary

Modifier and Type	Method and Description
void	erase(Binary binKey) Remove the specified key from the underlying store if present.
void	eraseAll() Remove all data from the underlying store.
Iterator<Binary>	keys() Iterate all keys in the underlying store.
Binary	load(Binary binKey) Return the value associated with the specified key, or null if the key does not have an associated value in the underlying store.
void	store(Binary binKey, Binary binValue) Store the specified value under the specific key in the underlying store.

Method Detail

load

Binary load(Binary binKey)

Return the value associated with the specified key, or null if the key does not have an associated value in the underlying store.

Parameters:

binKey - key whose associated value is to be returned

Returns:

the value associated with the specified key, or null if no value is available for that key

store

void store(Binary binKey,
           Binary binValue)

Store the specified value under the specific key in the underlying store. This method is intended to support both key/value creation and value update for a specific key.

Parameters:

binKey - key to store the value under

binValue - value to be stored

Throws:

UnsupportedOperationException - if this implementation or the underlying store is read-only

erase

void erase(Binary binKey)

Remove the specified key from the underlying store if present.

Parameters:

binKey - key whose mapping is to be removed from the map

Throws:

UnsupportedOperationException - if this implementation or the underlying store is read-only

eraseAll

void eraseAll()

Remove all data from the underlying store.

Throws:

UnsupportedOperationException - if this implementation or the underlying store is read-only

keys

Iterator<Binary> keys()

Iterate all keys in the underlying store.

Returns:

a read-only iterator of the keys in the underlying store

Throws:

UnsupportedOperationException - if the underlying store is not iterable