org.spf4j.recyclable

Interface ObjectBorower<T>

All Superinterfaces:

Scanable<T>

public interface ObjectBorower<T>
extends Scanable<T>

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectBorower.Action

Nested classes/interfaces inherited from interface org.spf4j.recyclable.Scanable

Scanable.ScanHandler<O>

Method Summary

Methods

Modifier and Type	Method and Description
Either<ObjectBorower.Action,T>	tryRequestReturnObject() Non Blocking method.
T	tryReturnObjectIfNotInUse() Non Blocking method.
Collection<T>	tryReturnObjectsIfNotInUse() Return all objects that are not currently in use.
Collection<T>	tryReturnObjectsIfNotNeededAnymore() This method is a cleanup method.

Methods inherited from interface org.spf4j.recyclable.Scanable

scan

Method Detail

tryRequestReturnObject

@Nonnull
Either<ObjectBorower.Action,T> tryRequestReturnObject()
                                                      throws InterruptedException

Non Blocking method.

Returns:

null if request was not made, the object if available, or REQUEST_MADE if request could be made to return Object.

Throws:

InterruptedException

tryReturnObjectIfNotInUse

@Nullable
T tryReturnObjectIfNotInUse()
                            throws InterruptedException

Non Blocking method.

Returns:

null or the object if available.

Throws:

InterruptedException

tryReturnObjectsIfNotInUse

@Nullable
Collection<T> tryReturnObjectsIfNotInUse()
                                         throws InterruptedException

Return all objects that are not currently in use.

Throws:

InterruptedException

tryReturnObjectsIfNotNeededAnymore

@Nullable
Collection<T> tryReturnObjectsIfNotNeededAnymore()
                                                 throws InterruptedException

This method is a cleanup method. The purpose is to recover all borrowed objects before once this borrower will never use them anymore...

Returns:

all objects borrowed

Throws:

InterruptedException