ManagedObjectPool (OfficeFloor 3.33.0 API)

All Known Implementing Classes:

AbstractHttpServerImplementationTestCase.CancelConnectionManagedObjectSource
```
public interface ManagedObjectPool
```
Pool of ManagedObject instances.

Author:

Daniel Sagenschneider

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`empty()`	Invoked on close of the `OfficeFloor` to allow handling pooled `ManagedObject` instances.
`default ManagedObject`	`getSourcedManagedObject(ManagedObject pooledManagedObject)`	Should the `ManagedObjectPool` create a wrapper `ManagedObject` for pooling, this method is required to be implemented to extract the `ManagedObject` sourced from the `ManagedObjectSource`.
`void`	`lostManagedObject(ManagedObject managedObject, java.lang.Throwable cause)`	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
  - getSourcedManagedObject
```
default ManagedObject getSourcedManagedObject(ManagedObject pooledManagedObject)
```
    Should the ManagedObjectPool create a wrapper ManagedObject for pooling, this method is required to be implemented to extract the ManagedObject sourced from the ManagedObjectSource.
    
    Parameters:
    
    pooledManagedObject - ManagedObject source from this ManagedObjectPool.
    
    Returns:
    
    ManagedObject sourced from the underlying ManagedObjectSource.
  - 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,
                       java.lang.Throwable cause)
```
    Flags that the ManagedObject is lost.
    
    Parameters:
    
    managedObject - ManagedObject to no longer be used.
    
    cause - Cause for the ManagedObject to be lost.
  - empty
```
void empty()
```
    Invoked on close of the OfficeFloor to allow handling pooled ManagedObject instances.