net.officefloor.frame.spi.managedobject.pool

Interface ManagedObjectPool

All Known Implementing Classes:

PassiveManagedObjectPool

public interface ManagedObjectPool

Pool of ManagedObject instances.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	init(ManagedObjectPoolContext context) Initiates this ManagedObjectPool.
void	lostManagedObject(ManagedObject managedObject) Flags that the ManagedObject is lost.
void	returnManagedObject(ManagedObject managedObject) Returns an instance to the pool.
void	sourceManagedObject(ManagedObjectUser user) Sources the ManagedObject from this ManagedObjectPool.

Method Detail

init

void init(ManagedObjectPoolContext context)
   throws Exception

Initiates this ManagedObjectPool.

Parameters:

context - Context for this ManagedObjectPool.

Throws:

Exception - If fails to initiate.

sourceManagedObject

void sourceManagedObject(ManagedObjectUser user)

Sources the ManagedObject from this ManagedObjectPool.

Parameters:

user - ManagedObjectUser requiring the ManagedObject.

returnManagedObject

void returnManagedObject(ManagedObject managedObject)

Returns an instance to the pool.

Parameters:

managedObject - ManagedObject.

lostManagedObject

void lostManagedObject(ManagedObject managedObject)

Flags that the ManagedObject is lost.

Parameters:

managedObject - ManagedObject to no longer be used.