PooledObject

类型参数:

T - the type of object in the pool

所有超级接口:

java.lang.Comparable<PooledObject<T>>

所有已知实现类:

DefaultPooledObject, PooledSoftReference
```
public interface PooledObject<T>
extends java.lang.Comparable<PooledObject<T>>
```
Defines the wrapper that is used to track the additional information, such as state, for the pooled objects.
Implementations of this class are required to be thread-safe.

从以下版本开始:

2.0

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`boolean`	`allocate()` Allocates the object.
`int`	`compareTo(PooledObject<T> other)` Orders instances based on idle time - i.e. the length of time since the instance was returned to the pool.
`boolean`	`deallocate()` Deallocates the object and sets it `IDLE` if it is currently `ALLOCATED`.
`boolean`	`endEvictionTest(java.util.Deque<PooledObject<T>> idleQueue)` Called to inform the object that the eviction test has ended.
`boolean`	`equals(java.lang.Object obj)`
`default java.time.Duration`	`getActiveTime()` Gets the amount of time this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).
`long`	`getActiveTimeMillis()` Gets the amount of time in milliseconds this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).
`default long`	`getBorrowedCount()` Gets the number of times this object has been borrowed.
`long`	`getCreateTime()` Gets the time (using the same basis as `System.currentTimeMillis()`) that this object was created.
`default java.time.Duration`	`getIdleTime()` Gets the amount of time that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).
`long`	`getIdleTimeMillis()` Gets the amount of time in milliseconds that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).
`long`	`getLastBorrowTime()` Gets the time the wrapped object was last borrowed.
`long`	`getLastReturnTime()` Gets the time the wrapped object was last returned.
`long`	`getLastUsedTime()` Gets an estimate of the last time this object was used.
`T`	`getObject()` Gets the underlying object that is wrapped by this instance of `PooledObject`.
`PooledObjectState`	`getState()` Gets the state of this object.
`int`	`hashCode()`
`void`	`invalidate()` Sets the state to `INVALID`
`void`	`markAbandoned()` Marks the pooled object as abandoned.
`void`	`markReturning()` Marks the object as returning to the pool.
`void`	`printStackTrace(java.io.PrintWriter writer)` Prints the stack trace of the code that borrowed this pooled object and the stack trace of the last code to use this object (if available) to the supplied writer.
`void`	`setLogAbandoned(boolean logAbandoned)` Is abandoned object tracking being used?
`default void`	`setRequireFullStackTrace(boolean requireFullStackTrace)` Configures the stack trace generation strategy based on whether or not fully detailed stack traces are required.
`boolean`	`startEvictionTest()` Attempts to place the pooled object in the `PooledObjectState.EVICTION` state.
`java.lang.String`	`toString()` Provides a String form of the wrapper for debug purposes.
`void`	`use()` Record the current stack trace as the last time the object was used.

- 方法详细资料
  - allocate
```
boolean allocate()
```
    Allocates the object.
    
    返回:
    
    true if the original state was IDLE
  - compareTo
```
int compareTo(PooledObject<T> other)
```
    Orders instances based on idle time - i.e. the length of time since the instance was returned to the pool. Used by the GKOP idle object evictor.
    Note: This class has a natural ordering that is inconsistent with equals if distinct objects have the same identity hash code.
    
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<PooledObject<T>>
  - deallocate
```
boolean deallocate()
```
    Deallocates the object and sets it IDLE if it is currently ALLOCATED.
    
    返回:
    
    true if the state was ALLOCATED
  - endEvictionTest
```
boolean endEvictionTest(java.util.Deque<PooledObject<T>> idleQueue)
```
    Called to inform the object that the eviction test has ended.
    
    参数:
    
    idleQueue - The queue of idle objects to which the object should be returned
    
    返回:
    
    Currently not used
  - equals
```
boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - getActiveTime
```
default java.time.Duration getActiveTime()
```
    Gets the amount of time this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).
    
    返回:
    
    The duration last spent in the active state
    
    从以下版本开始:
    
    2.12.0
  - getActiveTimeMillis
```
long getActiveTimeMillis()
```
    Gets the amount of time in milliseconds this object last spent in the active state (it may still be active in which case subsequent calls will return an increased value).
    
    返回:
    
    The time in milliseconds last spent in the active state
  - getBorrowedCount
```
default long getBorrowedCount()
```
    Gets the number of times this object has been borrowed.
    
    返回:
    
    -1 by default for old implementations prior to release 2.7.0.
    
    从以下版本开始:
    
    2.7.0
  - getCreateTime
```
long getCreateTime()
```
    Gets the time (using the same basis as System.currentTimeMillis()) that this object was created.
    
    返回:
    
    The creation time for the wrapped object
  - getIdleTime
```
default java.time.Duration getIdleTime()
```
    Gets the amount of time that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).
    
    返回:
    
    The amount of time in last spent in the idle state.
    
    从以下版本开始:
    
    2.10.0
  - getIdleTimeMillis
```
long getIdleTimeMillis()
```
    Gets the amount of time in milliseconds that this object last spend in the idle state (it may still be idle in which case subsequent calls will return an increased value).
    
    返回:
    
    The time in milliseconds last spent in the idle state
  - getLastBorrowTime
```
long getLastBorrowTime()
```
    Gets the time the wrapped object was last borrowed.
    
    返回:
    
    The time the object was last borrowed
  - getLastReturnTime
```
long getLastReturnTime()
```
    Gets the time the wrapped object was last returned.
    
    返回:
    
    The time the object was last returned
  - getLastUsedTime
```
long getLastUsedTime()
```
    Gets an estimate of the last time this object was used. If the class of the pooled object implements TrackedUse, what is returned is the maximum of TrackedUse.getLastUsed() and getLastBorrowTime(); otherwise this method gives the same value as getLastBorrowTime().
    
    返回:
    
    the last time this object was used
  - getObject
```
T getObject()
```
    Gets the underlying object that is wrapped by this instance of PooledObject.
    
    返回:
    
    The wrapped object
  - getState
```
PooledObjectState getState()
```
    Gets the state of this object.
    
    返回:
    
    state
  - hashCode
```
int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - invalidate
```
void invalidate()
```
    Sets the state to INVALID
  - markAbandoned
```
void markAbandoned()
```
    Marks the pooled object as abandoned.
  - markReturning
```
void markReturning()
```
    Marks the object as returning to the pool.
  - printStackTrace
```
void printStackTrace(java.io.PrintWriter writer)
```
    Prints the stack trace of the code that borrowed this pooled object and the stack trace of the last code to use this object (if available) to the supplied writer.
    
    参数:
    
    writer - The destination for the debug output
  - setLogAbandoned
```
void setLogAbandoned(boolean logAbandoned)
```
    Is abandoned object tracking being used? If this is true the implementation will need to record the stack trace of the last caller to borrow this object.
    
    参数:
    
    logAbandoned - The new configuration setting for abandoned object tracking
  - setRequireFullStackTrace
```
default void setRequireFullStackTrace(boolean requireFullStackTrace)
```
    Configures the stack trace generation strategy based on whether or not fully detailed stack traces are required. When set to false, abandoned logs may only include caller class information rather than method names, line numbers, and other normal metadata available in a full stack trace.
    
    参数:
    
    requireFullStackTrace - the new configuration setting for abandoned object logging
    
    从以下版本开始:
    
    2.7.0
  - startEvictionTest
```
boolean startEvictionTest()
```
    Attempts to place the pooled object in the PooledObjectState.EVICTION state.
    
    返回:
    
    true if the object was placed in the PooledObjectState.EVICTION state otherwise false
  - toString
```
java.lang.String toString()
```
    Provides a String form of the wrapper for debug purposes. The format is not fixed and may change at any time.
    
    覆盖:
    
    toString 在类中 java.lang.Object
  - use
```
void use()
```
    Record the current stack trace as the last time the object was used.

接口 PooledObject<T>

方法概要

方法详细资料

allocate

compareTo

deallocate

endEvictionTest

equals

getActiveTime

getActiveTimeMillis

getBorrowedCount

getCreateTime

getIdleTime

getIdleTimeMillis

getLastBorrowTime

getLastReturnTime

getLastUsedTime

getObject

getState

hashCode

invalidate

markAbandoned

markReturning

printStackTrace

setLogAbandoned

setRequireFullStackTrace

startEvictionTest

toString

use