T
- the type of object in the pooljava.lang.Comparable<PooledObject<T>>
DefaultPooledObject
, PooledSoftReference
public interface PooledObject<T> extends java.lang.Comparable<PooledObject<T>>
Implementations of this class are required to be thread-safe.
Modifier and Type | Method | Description |
---|---|---|
boolean |
allocate() |
Allocates the object.
|
int |
compareTo(PooledObject<T> other) |
Orders instances based on idle time - i.e.
|
boolean |
deallocate() |
|
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) |
|
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(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? 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. |
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.
|
boolean allocate()
true
if the original state was IDLE
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 java.lang.Comparable<T>
boolean deallocate()
true
if the state was ALLOCATED
boolean endEvictionTest(java.util.Deque<PooledObject<T>> idleQueue)
idleQueue
- The queue of idle objects to which the object should be
returnedboolean equals(java.lang.Object obj)
equals
in class java.lang.Object
long getActiveTimeMillis()
long getCreateTime()
System.currentTimeMillis()
) that this object was created.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()
.T getObject()
PooledObject
.PooledObjectState getState()
int hashCode()
hashCode
in class java.lang.Object
void invalidate()
INVALID
void markAbandoned()
void markReturning()
void printStackTrace(java.io.PrintWriter writer)
writer
- The destination for the debug outputvoid setLogAbandoned(boolean logAbandoned)
logAbandoned
- The new configuration setting for abandoned
object trackingboolean startEvictionTest()
PooledObjectState.EVICTION
state.true
if the object was placed in the
PooledObjectState.EVICTION
state otherwise
false
java.lang.String toString()
toString
in class java.lang.Object
void use()
Copyright © 2001-2014 Apache Software Foundation. Documenation generated September 14 2017.