Oracle® Coherence Java API Reference
v3.5

E14977-01

com.tangosol.net.cache
Class BinaryStoreCacheStore

java.lang.Object
  extended by com.tangosol.util.Base
      extended by com.tangosol.net.cache.AbstractCacheLoader
          extended by com.tangosol.net.cache.AbstractCacheStore
              extended by com.tangosol.net.cache.BinaryStoreCacheStore
All Implemented Interfaces:
CacheLoader, CacheStore, IterableCacheLoader

public class BinaryStoreCacheStore
extends AbstractCacheStore
implements CacheStore, IterableCacheLoader

A CacheStore that sits directly on top of a BinaryStore.

Since:
Coherence 2.5
Author:
cp 2004.09.24

Constructor Summary
BinaryStoreCacheStore(BinaryStore store)
          Create a CacheStore that delegates to a BinaryStore.
BinaryStoreCacheStore(BinaryStore store, boolean fBinaryOnly)
          Create a CacheStore that delegates to a BinaryStore, optionally storing only Binary keys and values.
BinaryStoreCacheStore(BinaryStore store, java.lang.ClassLoader loader)
          Create a CacheStore that delegates to a BinaryStore, using the passed ClassLoader for deserialization.
 
Method Summary
 void erase(java.lang.Object oKey)
          Remove the specified key from the underlying store if present.
protected  java.lang.Object fromBinary(Binary bin)
          Translate the passed Binary object into an Object object.
 BinaryStore getBinaryStore()
          Returns the BinaryStore that this CacheStore uses for its storage.
 java.lang.ClassLoader getClassLoader()
          Returns the ClassLoader that this CacheStore uses for deserialization, if it has one.
 boolean isBinaryOnly()
          Determine if the keys and values in this CacheStore are known to be all Binary.
 java.util.Iterator keys()
          Iterate all keys in the underlying store.
 java.lang.Object load(java.lang.Object oKey)
          Return the value associated with the specified key, or null if the key does not have an associated value in the underlying store.
protected  void setBinaryStore(BinaryStore store)
          Configures the BinaryStore that this CacheStore will use for its storage.
protected  void setClassLoader(java.lang.ClassLoader loader)
          Configure the ClassLoader that this CacheStore will use for deserialization.
 void store(java.lang.Object oKey, java.lang.Object oValue)
          Store the specified value under the specified key in the underlying store.
protected  Binary toBinary(java.lang.Object o)
          Translate the passed Object object into an Binary object.
 
Methods inherited from class com.tangosol.net.cache.AbstractCacheStore
eraseAll, storeAll
 
Methods inherited from class com.tangosol.net.cache.AbstractCacheLoader
loadAll
 
Methods inherited from interface com.tangosol.net.cache.CacheStore
eraseAll, storeAll
 
Methods inherited from interface com.tangosol.net.cache.CacheLoader
loadAll
 
Methods inherited from interface com.tangosol.net.cache.CacheLoader
loadAll
 

Constructor Detail

BinaryStoreCacheStore

public BinaryStoreCacheStore(BinaryStore store)
Create a CacheStore that delegates to a BinaryStore.

Parameters:
store - the BinaryStore to use to write the serialized objects to

BinaryStoreCacheStore

public BinaryStoreCacheStore(BinaryStore store,
                             java.lang.ClassLoader loader)
Create a CacheStore that delegates to a BinaryStore, using the passed ClassLoader for deserialization.

Parameters:
store - the BinaryStore to use to write the serialized objects to
loader - the ClassLoader to use for deserialization

BinaryStoreCacheStore

public BinaryStoreCacheStore(BinaryStore store,
                             boolean fBinaryOnly)
Create a CacheStore that delegates to a BinaryStore, optionally storing only Binary keys and values.

Parameters:
store - the BinaryStore to use to write the serialized objects to
fBinaryOnly - true indicates that this CacheStore will only manage binary keys and values
Method Detail

load

public java.lang.Object load(java.lang.Object oKey)
Return the value associated with the specified key, or null if the key does not have an associated value in the underlying store.

Specified by:
load in interface CacheLoader
Specified by:
load in class AbstractCacheLoader
Parameters:
oKey - 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

public void store(java.lang.Object oKey,
                  java.lang.Object oValue)
Store the specified value under the specified key in the underlying store. This method is intended to support both key/value creation and value update for a specific key.

Specified by:
store in interface CacheStore
Overrides:
store in class AbstractCacheStore
Parameters:
oKey - key to store the value under
oValue - value to be stored
Throws:
java.lang.UnsupportedOperationException - if this implementation or the underlying store is read-only

erase

public void erase(java.lang.Object oKey)
Remove the specified key from the underlying store if present.

Specified by:
erase in interface CacheStore
Overrides:
erase in class AbstractCacheStore
Parameters:
oKey - key to remove from the store
Throws:
java.lang.UnsupportedOperationException - if this implementation or the underlying store is read-only

keys

public java.util.Iterator keys()
Iterate all keys in the underlying store.

Specified by:
keys in interface IterableCacheLoader
Returns:
a read-only iterator of the keys in the underlying store
Throws:
java.lang.UnsupportedOperationException - if the underlying store is not iterable

toBinary

protected Binary toBinary(java.lang.Object o)
Translate the passed Object object into an Binary object.

Parameters:
o - the Object to serialize into a Binary object
Returns:
the Binary object

fromBinary

protected java.lang.Object fromBinary(Binary bin)
Translate the passed Binary object into an Object object.

Parameters:
bin - the Binary object to deserialize
Returns:
the deserialized object

getBinaryStore

public BinaryStore getBinaryStore()
Returns the BinaryStore that this CacheStore uses for its storage.

Returns:
the BinaryStore that this CacheStore uses

setBinaryStore

protected void setBinaryStore(BinaryStore store)
Configures the BinaryStore that this CacheStore will use for its storage.

Parameters:
store - the BinaryStore to use

getClassLoader

public java.lang.ClassLoader getClassLoader()
Returns the ClassLoader that this CacheStore uses for deserialization, if it has one.

Returns:
the ClassLoader that this CacheStore uses for deserialization; may be null

setClassLoader

protected void setClassLoader(java.lang.ClassLoader loader)
Configure the ClassLoader that this CacheStore will use for deserialization.

Parameters:
loader - the ClassLoader that this CacheStore should use for deserialization

isBinaryOnly

public boolean isBinaryOnly()
Determine if the keys and values in this CacheStore are known to be all Binary.

Returns:
true if all keys and values will be Binary to start with, and thus will not require conversion

Oracle® Coherence Java API Reference
v3.5

E14977-01

Copyright © 2000, 2009, Oracle. All rights reserved.