ObjectPool (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.tools.pool.ObjectPool<T>

```
public class ObjectPool<T>
extends Object
```
对象池支持超时清理,并且支持指定对象的借出和归还操作仅仅按照时间长短控制对象的存活周期

Author:

helyho
Vestful Framework. WebSite: https://github.com/helyho/Vestful Licence: Apache v2 License

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ObjectPool.InnerObject<T>
池中缓存的对象模型

Nested Classes
Modifier and Type	Class and Description
`class`	`ObjectPool.InnerObject<T>` 池中缓存的对象模型

Constructor Summary

Constructors
Constructor and Description
`ObjectPool()` 构造一个对象池
`ObjectPool(long aliveTime)` 构造一个对象池
`ObjectPool(long aliveTime, boolean autoRefreshOnGet)` 构造一个对象池

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`add(T obj)` 增加池中的对象
`ObjectPool<T>`	`aliveTime(long aliveTime)` 设置对象池的对象存活时间
`ObjectPool<T>`	`autoRefreshOnGet(boolean autoRefreshOnGet)`
`int`	`avaliableSize()` 可用的对象数
`T`	`borrow()` 借出这个对象如果有提供 supplier 函数, 在没有可借出对象时会构造一个新的对象, 否则返回 null
`T`	`borrow(long waitTime)` 借出对象
`int`	`borrowedSize()` 出借的对象数
`void`	`clear()` 清理池中所有的对象
`boolean`	`contains(long id)` 判断池中是否存在对象
`ObjectPool<T>`	`create()` 创建ObjectPool
`Function<T,Boolean>`	`destory()` 获取对象销毁函数在对象被销毁前工作
`ObjectPool<T>`	`destory(Function<T,Boolean> destory)` 设置对象销毁函数在对象被销毁前工作
`long`	`getAliveTime()`
`int`	`getInterval()`
`int`	`getMaxSize()`
`int`	`getMinSize()`
`Supplier<T>`	`getSupplier()` 获取对象构造函数在对象被构造工作
`void`	`initObjects()` 按照 minSize 初始化最小容量的对象
`ObjectPool<T>`	`interval(int interval)`
`boolean`	`isAutoRefreshOnGet()` 是否获取对象时刷新对象存活时间
`ObjectPool<T>`	`maxSize(int maxSize)`
`ObjectPool<T>`	`minSize(int minSize)`
`void`	`restitution(T obj)` 归还借出的对象
`int`	`size()` 获取当前对象池的大小
`ObjectPool<T>`	`supplier(Supplier<T> supplier)` 设置对象构造函数对象被构造是用的函数
`String`	`toString()`
`Function<T,Boolean>`	`validator()` 验证器在获取对象时验证
`ObjectPool<T>`	`validator(Function<T,Boolean> validator)` 设置验证器在获取对象时验证

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ObjectPool
```
public ObjectPool(long aliveTime,
                  boolean autoRefreshOnGet)
```
    构造一个对象池
    
    Parameters:
    
    aliveTime - 对象存活时间,小于等于0时为一直存活,单位:秒
    
    autoRefreshOnGet - 获取对象时刷新对象存活时间
  - ObjectPool
```
public ObjectPool(long aliveTime)
```
    构造一个对象池
    
    Parameters:
    
    aliveTime - 对象存活时间,单位:秒
  - ObjectPool
```
public ObjectPool()
```
    构造一个对象池
- Method Detail
  - getAliveTime
```
public long getAliveTime()
```
  - autoRefreshOnGet
```
public ObjectPool<T> autoRefreshOnGet(boolean autoRefreshOnGet)
```
  - getMinSize
```
public int getMinSize()
```
  - minSize
```
public ObjectPool<T> minSize(int minSize)
```
  - getMaxSize
```
public int getMaxSize()
```
  - maxSize
```
public ObjectPool<T> maxSize(int maxSize)
```
  - getInterval
```
public int getInterval()
```
  - interval
```
public ObjectPool<T> interval(int interval)
```
  - getSupplier
```
public Supplier<T> getSupplier()
```
    获取对象构造函数在对象被构造工作
    
    Returns:
    
    对象构造函数
  - supplier
```
public ObjectPool<T> supplier(Supplier<T> supplier)
```
    设置对象构造函数对象被构造是用的函数
    
    Parameters:
    
    supplier - 对象构造函数
    
    Returns:
    
    ObjectPool 对象
  - validator
```
public Function<T,Boolean> validator()
```
    验证器在获取对象时验证
    
    Returns:
    
    Function 对象
  - validator
```
public ObjectPool<T> validator(Function<T,Boolean> validator)
```
    设置验证器在获取对象时验证
    
    Parameters:
    
    validator - Function 对象
    
    Returns:
    
    ObjectPool 对象
  - destory
```
public Function<T,Boolean> destory()
```
    获取对象销毁函数在对象被销毁前工作
    
    Returns:
    
    对象销毁函数
  - destory
```
public ObjectPool<T> destory(Function<T,Boolean> destory)
```
    设置对象销毁函数在对象被销毁前工作
    
    Parameters:
    
    destory - 对象销毁函数
    
    Returns:
    
    ObjectPool 对象
  - aliveTime
```
public ObjectPool<T> aliveTime(long aliveTime)
```
    设置对象池的对象存活时间
    
    Parameters:
    
    aliveTime - 对象存活时间,单位:秒
    
    Returns:
    
    ObjectPool 对象
  - isAutoRefreshOnGet
```
public boolean isAutoRefreshOnGet()
```
    是否获取对象时刷新对象存活时间
    
    Returns:
    
    是否获取对象时刷新对象存活时间
  - add
```
public Long add(T obj)
```
    增加池中的对象
    
    Parameters:
    
    obj - 增加到池中的对象
    
    Returns:
    
    对象的 id 值
  - borrow
```
public T borrow()
```
    借出这个对象如果有提供 supplier 函数, 在没有可借出对象时会构造一个新的对象, 否则返回 null
    
    Returns:
    
    借出的对象
  - borrow
```
public T borrow(long waitTime)
         throws TimeoutException
```
    借出对象
    
    Parameters:
    
    waitTime - 超时时间
    
    Returns:
    
    借出的对象, 超时返回 null
    
    Throws:
    
    TimeoutException - 超时异常
  - restitution
```
public void restitution(T obj)
```
    归还借出的对象
    
    Parameters:
    
    obj - 借出的对象
  - contains
```
public boolean contains(long id)
```
    判断池中是否存在对象
    
    Parameters:
    
    id - 对象的 hash 值
    
    Returns:
    
    true: 存在, false: 不存在
  - size
```
public int size()
```
    获取当前对象池的大小
    
    Returns:
    
    对象池的大小
  - borrowedSize
```
public int borrowedSize()
```
    出借的对象数
    
    Returns:
    
    出借的对象数
  - avaliableSize
```
public int avaliableSize()
```
    可用的对象数
    
    Returns:
    
    可用的对象数
  - clear
```
public void clear()
```
    清理池中所有的对象
  - initObjects
```
public void initObjects()
```
    按照 minSize 初始化最小容量的对象
  - create
```
public ObjectPool<T> create()
```
    创建ObjectPool
    
    Returns:
    
    ObjectPool 对象
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ObjectPool<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectPool

ObjectPool

ObjectPool

Method Detail

getAliveTime

autoRefreshOnGet

getMinSize

minSize

getMaxSize

maxSize

getInterval

interval

getSupplier

supplier

validator

validator

destory

destory

aliveTime

isAutoRefreshOnGet

add

borrow

borrow

restitution

contains

size

borrowedSize

avaliableSize

clear

initObjects

create

toString