com.firefly.utils.lang.pool

接口 BlockingPool<T>

所有超级接口:

LifeCycle, Pool<T>

所有已知实现类:

BoundedBlockingPool

public interface BlockingPool<T>
extends Pool<T>

Represents a pool of objects that makes the requesting threads wait if no object is available.

嵌套类概要

从接口继承的嵌套类/接口 com.firefly.utils.lang.pool.Pool

Pool.Dispose<T>, Pool.Validator<T>

方法概要

限定符和类型	方法和说明
void	put(T e) Inserts the specified element into this queue, waiting if necessary for space to become available.
boolean	put(T e, long timeout, TimeUnit unit) Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
T	take() Returns an instance of type T from the pool.
T	take(long time, TimeUnit unit) Returns an instance of type T from the pool, waiting up to the specified wait time if necessary for an object to become available..

从接口继承的方法 com.firefly.utils.lang.pool.Pool

cleanup, get, release, size

从接口继承的方法 com.firefly.utils.lang.LifeCycle

isStarted, isStopped, start, stop

方法详细资料

take

T take()
throws InterruptedException

Returns an instance of type T from the pool. The call is a blocking call, and client threads are made to wait indefinitely until an object is available. The call implements a fairness algorithm that ensures that a FCFS service is implemented. Clients are advised to react to InterruptedException. If the thread is interrupted while waiting for an object to become available, the current implementations sets the interrupted state of the thread to true and returns null. However this is subject to change from implementation to implementation.

返回:

T an instance of the Object of type T from the pool.

抛出:

InterruptedException

take

T take(long time,
       TimeUnit unit)
throws InterruptedException

Returns an instance of type T from the pool, waiting up to the specified wait time if necessary for an object to become available.. The call is a blocking call, and client threads are made to wait for time until an object is available or until the timeout occurs. The call implements a fairness algorithm that ensures that a FCFS service is implemented. Clients are advised to react to InterruptedException. If the thread is interrupted while waiting for an object to become available, the current implementations set the interrupted state of the thread to true and returns null. However this is subject to change from implementation to implementation.

参数:

time - amount of time to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

返回:

T an instance of the Object of type T from the pool.

抛出:

InterruptedException - if interrupted while waiting

put

void put(T e)
  throws InterruptedException

Inserts the specified element into this queue, waiting if necessary for space to become available.

参数:

e - the element to add

抛出:

InterruptedException - if interrupted while waiting

ClassCastException - if the class of the specified element prevents it from being added to this queue

NullPointerException - if the specified element is null

IllegalArgumentException - if some property of the specified element prevents it from being added to this queue

put

boolean put(T e,
            long timeout,
            TimeUnit unit)
     throws InterruptedException

Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

参数:

e - the element to add

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

返回:

true if successful, or false if the specified waiting time elapses before space is available

抛出:

InterruptedException - if interrupted while waiting

ClassCastException - if the class of the specified element prevents it from being added to this queue

NullPointerException - if the specified element is null

IllegalArgumentException - if some property of the specified element prevents it from being added to this queue