|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- the type of object in the poolpublic interface 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.
Method Summary | |
---|---|
boolean |
allocate()
Allocates the object. |
int |
compareTo(PooledObject<T> other)
Orders instances based on idle time - i.e. |
boolean |
deallocate()
Deallocates the object and sets it IDLE
if it is currently ALLOCATED . |
boolean |
endEvictionTest(Deque<PooledObject<T>> idleQueue)
Called to inform the object that the eviction test has ended. |
boolean |
equals(Object obj)
|
long |
getActiveTimeMillis()
Obtain the time in milliseconds that this object last spent in the the active state (it may still be active in which case subsequent calls will return an increased value). |
long |
getCreateTime()
Obtain the time (using the same basis as System.currentTimeMillis() ) that this object was created. |
long |
getIdleTimeMillis()
Obtain the time in milliseconds that this object last spend in the the idle state (it may still be idle in which case subsequent calls will return an increased value). |
long |
getLastBorrowTime()
Obtain the time the wrapped object was last borrowed. |
long |
getLastReturnTime()
Obtain the time the wrapped object was last returned. |
long |
getLastUsedTime()
Return an estimate of the last time this object was used. |
T |
getObject()
Obtain the underlying object that is wrapped by this instance of PooledObject . |
PooledObjectState |
getState()
Returns 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(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? If this is true the implementation will need to record the stack trace of the last caller to borrow this object. |
boolean |
startEvictionTest()
Attempt to place the pooled object in the PooledObjectState.EVICTION state. |
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. |
Method Detail |
---|
T getObject()
PooledObject
.
long getCreateTime()
System.currentTimeMillis()
) that this object was created.
long getActiveTimeMillis()
long getIdleTimeMillis()
long getLastBorrowTime()
long getLastReturnTime()
long getLastUsedTime()
TrackedUse
, what is returned is
the maximum of TrackedUse.getLastUsed()
and
getLastBorrowTime()
; otherwise this method gives the same
value as getLastBorrowTime()
.
int compareTo(PooledObject<T> other)
Note: This class has a natural ordering that is inconsistent with equals if distinct objects have the same identity hash code.
compareTo
in interface Comparable<PooledObject<T>>
boolean equals(Object obj)
equals
in class Object
int hashCode()
hashCode
in class Object
String toString()
toString
in class Object
boolean startEvictionTest()
PooledObjectState.EVICTION
state.
true
if the object was placed in the
PooledObjectState.EVICTION
state otherwise
false
boolean endEvictionTest(Deque<PooledObject<T>> idleQueue)
idleQueue
- The queue if idle objects to which the object should be
returned
boolean allocate()
true
if the original state was IDLE
boolean deallocate()
IDLE
if it is currently ALLOCATED
.
true
if the state was ALLOCATED
void invalidate()
INVALID
void setLogAbandoned(boolean logAbandoned)
logAbandoned
- The new configuration setting for abandoned
object trackingvoid use()
void printStackTrace(PrintWriter writer)
writer
- The destination for the debug outputPooledObjectState getState()
void markAbandoned()
void markReturning()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |