Package net.officefloor.frame.api.managedobject.recycle

Interface RecycleManagedObjectParameter<MO extends ManagedObject>

public interface RecycleManagedObjectParameter<MO extends ManagedObject>

Parameter to the recycle ManagedFunction.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
CleanupEscalation[]	getCleanupEscalations()	Obtains possible CleanupEscalation instances that occurred in cleaning up previous ManagedObject instances.
MO	getManagedObject()	Obtains the ManagedObject being recycled.
static <M extends ManagedObject> RecycleManagedObjectParameter<M>	getRecycleManagedObjectParameter(ManagedFunctionContext<?,?> context)	Convenience method to obtain the RecycleManagedObjectParameter from the ManagedFunctionContext.
void	reuseManagedObject()	Invoked at the end of recycling to re-use the ManagedObject.

Method Details

getRecycleManagedObjectParameter

static <M extends ManagedObject>
RecycleManagedObjectParameter<M> getRecycleManagedObjectParameter(ManagedFunctionContext<?,?> context)

Convenience method to obtain the RecycleManagedObjectParameter from the ManagedFunctionContext.

Type Parameters:

M - ManagedObject type.

Parameters:

context - ManagedFunctionContext.

Returns:

RecycleManagedObjectParameter.

getManagedObject

MO getManagedObject()

Obtains the ManagedObject being recycled.

Returns:

ManagedObject being recycled.

reuseManagedObject

void reuseManagedObject()

Invoked at the end of recycling to re-use the ManagedObject.

Should this method not be invoked, the ManagedObject will be destroyed.

getCleanupEscalations

CleanupEscalation[] getCleanupEscalations()

Obtains possible CleanupEscalation instances that occurred in cleaning up previous ManagedObject instances.

Returns:

Possible CleanupEscalation instances.