org.apache.java.recycle
Interface RecycleBin
- All Known Implementing Classes:
- Container, ControlledContainer, LimitedContainer, WorkerContainer
- public abstract interface RecycleBin
This interface standardize the behaviour of a RecycleBin
object, used to contain a pool of Recyclable
objects.
It also handles the process of storing and managing the recyclable
objects it contains.
- Version:
- $Revision: 1.3 $ $Date: 1999/06/24 00:50:50 $
Method Summary |
Recyclable |
getRecyclable()
This method is called to obtain a recyclable object from this
recycle bin. |
int |
getSize()
This method returns the actual number of recyclable objects
contained in this recycle bin. |
void |
recycle(Recyclable object)
This method is called to recycle a recyclable object into this
container. |
getRecyclable
public Recyclable getRecyclable()
- This method is called to obtain a recyclable object from this
recycle bin.
- Throws:
- RecycleBinIsEmpty - when recycle bin is empty.
recycle
public void recycle(Recyclable object)
- This method is called to recycle a recyclable object into this
container.
The
clean()
method is guaranteed to be called by
the RecycleBin implementation before the object is
stored.
- Throws:
- ObjectWasDestroyed - when object is destroied.
getSize
public int getSize()
- This method returns the actual number of recyclable objects
contained in this recycle bin.