net.walend.lyophil
Interface Freezer

All Known Implementing Classes:

EJBFreezer, JDBCFreezer, MemFreezer, QueuedWriteFreezer, SoftFreezer

public interface Freezer

This interface defines the basic functions for persisting an object.

Since:

20001121

Author:

David Walend

Field Summary

static java.lang.String

ROLE

Method Summary

int	count() Returns the number of elements in this collection.
void	freeze(Freezable victem) Take the Thawed victem and put it in cold storage.
SetOfFreezables	getAll() Returns a lyophilizer.collection.Set of Freezables.
boolean	isAvailable(java.io.Serializable identifier) Return true if identifier is available in the freezer
boolean	isEmpty() Returns true if this collection contains no elements.
Freezable	thaw(java.io.Serializable identifier) For the identifier, return a Freezable object containing the data.
void	throwOut(java.io.Serializable identifier) Remote the Freezable identified by identifier from the persistent storage
void	throwOutAll() Throw out everything in the Freezer.

Field Detail

ROLE

public static final java.lang.String ROLE

Method Detail

freeze

public void freeze(Freezable victem)

Take the Thawed victem and put it in cold storage.

Throws:

CannotFreezeException

thaw

public Freezable thaw(java.io.Serializable identifier)
               throws NotInFreezerException

For the identifier, return a Freezable object containing the data.

Throws:

CannotThawException

NotInFreezerException

throwOut

public void throwOut(java.io.Serializable identifier)
              throws NotInFreezerException

Remote the Freezable identified by identifier from the persistent storage

Throws:

CannotThrowOutException

NotInFreezerException

isAvailable

public boolean isAvailable(java.io.Serializable identifier)

Return true if identifier is available in the freezer

Throws:

PersistenceFailureException

throwOutAll

public void throwOutAll()

Throw out everything in the Freezer.

getAll

public SetOfFreezables getAll()

Returns a lyophilizer.collection.Set of Freezables.

Throws:

PersistenceFailureException

count

public int count()

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.