org.apache.commons.cache
Class BaseStash

java.lang.Object
  extended by org.apache.commons.cache.BaseStash
All Implemented Interfaces:
Serializable, Stash
Direct Known Subclasses:
FileStash, MemoryStash, ShareableFileStash

public abstract class BaseStash
extends Object
implements Stash

An abstract base Stash implementation, mapping the non-serialized versions of canStore(java.io.Serializable, java.io.Serializable, java.lang.Long, java.lang.Long, java.io.Serializable) and store(java.io.Serializable, java.io.Serializable, java.lang.Long, java.lang.Long, java.io.Serializable) to the serialized ones, and declaring wantsSerializedForm() to return false.

Version:
$Id: BaseStash.java 155435 2005-02-26 13:17:27Z dirkv $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.apache.commons.cache.Stash
NO, NO_FULL, NO_NOT_STORABLE, YES
 
Constructor Summary
BaseStash()
           
 
Method Summary
 int canStore(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group)
          Equivalent to canStore(key,val,expiresAt,cost,group,null)).
abstract  int canStore(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group, byte[] serialized)
           
abstract  float capacity()
           
abstract  void clear(Serializable key)
           
abstract  boolean contains(Serializable key)
           
abstract  Serializable retrieve(Serializable key)
           
abstract  void setCache(Cache c)
           
 boolean store(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group)
          Equivalent to canStore(key,val,expiresAt,cost,group,null)).
abstract  boolean store(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group, byte[] serialized)
           
abstract  void unsetCache()
           
 boolean wantsSerializedForm()
          Returns false.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.commons.cache.Stash
clear
 

Constructor Detail

BaseStash

public BaseStash()
Method Detail

canStore

public int canStore(Serializable key,
                    Serializable val,
                    Long expiresAt,
                    Long cost,
                    Serializable group)
Equivalent to canStore(key,val,expiresAt,cost,group,null)).

Specified by:
canStore in interface Stash

store

public boolean store(Serializable key,
                     Serializable val,
                     Long expiresAt,
                     Long cost,
                     Serializable group)
Equivalent to canStore(key,val,expiresAt,cost,group,null)).

Specified by:
store in interface Stash

wantsSerializedForm

public boolean wantsSerializedForm()
Returns false.

Specified by:
wantsSerializedForm in interface Stash
Returns:
false.

canStore

public abstract int canStore(Serializable key,
                             Serializable val,
                             Long expiresAt,
                             Long cost,
                             Serializable group,
                             byte[] serialized)
Specified by:
canStore in interface Stash

store

public abstract boolean store(Serializable key,
                              Serializable val,
                              Long expiresAt,
                              Long cost,
                              Serializable group,
                              byte[] serialized)
Specified by:
store in interface Stash

retrieve

public abstract Serializable retrieve(Serializable key)
Specified by:
retrieve in interface Stash

contains

public abstract boolean contains(Serializable key)
Specified by:
contains in interface Stash

capacity

public abstract float capacity()
Specified by:
capacity in interface Stash

clear

public abstract void clear(Serializable key)
Specified by:
clear in interface Stash

setCache

public abstract void setCache(Cache c)
Specified by:
setCache in interface Stash

unsetCache

public abstract void unsetCache()
Specified by:
unsetCache in interface Stash


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.