Package org.apache.tomcat.dbcp.pool2
Interface PooledObject<T>
- 
- Type Parameters:
- T- the type of object in the pool
 - All Superinterfaces:
- java.lang.Comparable<PooledObject<T>>
 - All Known Implementing Classes:
- 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. - Since:
- 2.0
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description booleanallocate()Allocates the object.intcompareTo(PooledObject<T> other)Orders instances based on idle time - i.e. the length of time since the instance was returned to the pool.booleandeallocate()booleanendEvictionTest(java.util.Deque<PooledObject<T>> idleQueue)Notifies the object that the eviction test has ended.booleanequals(java.lang.Object obj)default java.time.DurationgetActiveDuration()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).default java.time.DurationgetActiveTime()Deprecated.UsegetActiveDuration().longgetActiveTimeMillis()Deprecated.UsegetActiveTime()which offers the best precision.default longgetBorrowedCount()Gets the number of times this object has been borrowed.default java.time.InstantgetCreateInstant()Gets the time (using the same basis asInstant.now()) that this object was created.longgetCreateTime()Deprecated.UsegetCreateInstant()which offers the best precision.default java.time.DurationgetFullDuration()Computes the duration since this object was created (usingInstant.now()).default java.time.DurationgetIdleDuration()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).default java.time.DurationgetIdleTime()Deprecated.UsegetIdleDuration().longgetIdleTimeMillis()Deprecated.UsegetIdleTime()which offers the best precision.default java.time.InstantgetLastBorrowInstant()Gets the time the wrapped object was last borrowed.longgetLastBorrowTime()Deprecated.UsegetLastBorrowInstant()which offers the best precision.default java.time.InstantgetLastReturnInstant()Gets the time the wrapped object was last borrowed.longgetLastReturnTime()Deprecated.UsegetLastReturnInstant()which offers the best precision.default java.time.InstantgetLastUsedInstant()Gets an estimate of the last time this object was used.longgetLastUsedTime()Deprecated.UsegetLastUsedInstant()which offers the best precision.TgetObject()Gets the underlying object that is wrapped by this instance ofPooledObject.PooledObjectStategetState()Gets the state of this object.inthashCode()voidinvalidate()Sets the state toINVALID.voidmarkAbandoned()Marks the pooled object as abandoned.voidmarkReturning()Marks the object as returning to the pool.voidprintStackTrace(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.voidsetLogAbandoned(boolean logAbandoned)Sets whether to use abandoned object tracking.default voidsetRequireFullStackTrace(boolean requireFullStackTrace)Sets the stack trace generation strategy based on whether or not fully detailed stack traces are required.booleanstartEvictionTest()Attempts to place the pooled object in thePooledObjectState.EVICTIONstate.java.lang.StringtoString()Gets a String form of the wrapper for debug purposes.voiduse()Records the current stack trace as the last time the object was used.
 
- 
- 
- 
Method Detail- 
allocateboolean allocate() Allocates the object.- Returns:
- trueif the original state was- IDLE
 
 - 
compareToint 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. - Specified by:
- compareToin interface- java.lang.Comparable<T>
 
 - 
deallocateboolean deallocate() - Returns:
- trueif the state was- ALLOCATED.
 
 - 
endEvictionTestboolean endEvictionTest(java.util.Deque<PooledObject<T>> idleQueue) Notifies the object that the eviction test has ended.- Parameters:
- idleQueue- The queue of idle objects to which the object should be returned.
- Returns:
- Currently not used.
 
 - 
equalsboolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
getActiveDurationdefault java.time.Duration getActiveDuration() 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).- Returns:
- The duration last spent in the active state.
- Since:
- 2.11.0
 
 - 
getActiveTime@Deprecated default java.time.Duration getActiveTime() Deprecated.UsegetActiveDuration().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).- Returns:
- The duration last spent in the active state.
- Since:
- 2.10.0
 
 - 
getActiveTimeMillis@Deprecated long getActiveTimeMillis() Deprecated.UsegetActiveTime()which offers the best precision.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).- Returns:
- The time in milliseconds last spent in the active state.
 
 - 
getBorrowedCountdefault long getBorrowedCount() Gets the number of times this object has been borrowed.- Returns:
- -1 by default for implementations prior to release 2.7.0.
- Since:
- 2.7.0
 
 - 
getCreateInstantdefault java.time.Instant getCreateInstant() Gets the time (using the same basis asInstant.now()) that this object was created.- Returns:
- The creation time for the wrapped object.
- Since:
- 2.11.0
 
 - 
getCreateTime@Deprecated long getCreateTime() Deprecated.UsegetCreateInstant()which offers the best precision.Gets the time (using the same basis asSystem.currentTimeMillis()) that this object was created.- Returns:
- The creation time for the wrapped object.
 
 - 
getFullDurationdefault java.time.Duration getFullDuration() Computes the duration since this object was created (usingInstant.now()).- Returns:
- The duration since this object was created.
- Since:
- 2.12.0
 
 - 
getIdleDurationdefault java.time.Duration getIdleDuration() 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).- Returns:
- The amount of time in last spent in the idle state.
- Since:
- 2.11.0
 
 - 
getIdleTime@Deprecated default java.time.Duration getIdleTime() Deprecated.UsegetIdleDuration().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).- Returns:
- The amount of time in last spent in the idle state.
- Since:
- 2.10.0
 
 - 
getIdleTimeMillis@Deprecated long getIdleTimeMillis() Deprecated.UsegetIdleTime()which offers the best precision.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).- Returns:
- The time in milliseconds last spent in the idle state.
 
 - 
getLastBorrowInstantdefault java.time.Instant getLastBorrowInstant() Gets the time the wrapped object was last borrowed.- Returns:
- The time the object was last borrowed.
- Since:
- 2.11.0
 
 - 
getLastBorrowTime@Deprecated long getLastBorrowTime() Deprecated.UsegetLastBorrowInstant()which offers the best precision.Gets the time the wrapped object was last borrowed.- Returns:
- The time the object was last borrowed.
 
 - 
getLastReturnInstantdefault java.time.Instant getLastReturnInstant() Gets the time the wrapped object was last borrowed.- Returns:
- The time the object was last borrowed.
- Since:
- 2.11.0
 
 - 
getLastReturnTime@Deprecated long getLastReturnTime() Deprecated.UsegetLastReturnInstant()which offers the best precision.Gets the time the wrapped object was last returned.- Returns:
- The time the object was last returned.
 
 - 
getLastUsedInstantdefault java.time.Instant getLastUsedInstant() Gets an estimate of the last time this object was used. If the class of the pooled object implementsTrackedUse, what is returned is the maximum ofTrackedUse.getLastUsedInstant()andgetLastBorrowTime(); otherwise this method gives the same value asgetLastBorrowTime().- Returns:
- the last time this object was used
- Since:
- 2.11.0
 
 - 
getLastUsedTime@Deprecated long getLastUsedTime() Deprecated.UsegetLastUsedInstant()which offers the best precision.Gets an estimate of the last time this object was used. If the class of the pooled object implementsTrackedUse, what is returned is the maximum ofTrackedUse.getLastUsedInstant()andgetLastBorrowTime(); otherwise this method gives the same value asgetLastBorrowTime().- Returns:
- the last time this object was used.
 
 - 
getObjectT getObject() Gets the underlying object that is wrapped by this instance ofPooledObject.- Returns:
- The wrapped object.
 
 - 
getStatePooledObjectState getState() Gets the state of this object.- Returns:
- state
 
 - 
hashCodeint hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
invalidatevoid invalidate() Sets the state toINVALID.
 - 
markAbandonedvoid markAbandoned() Marks the pooled object as abandoned.
 - 
markReturningvoid markReturning() Marks the object as returning to the pool.
 - 
printStackTracevoid 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.- Parameters:
- writer- The destination for the debug output.
 
 - 
setLogAbandonedvoid setLogAbandoned(boolean logAbandoned) Sets whether to use abandoned object tracking. If this is true the implementation will need to record the stack trace of the last caller to borrow this object.- Parameters:
- logAbandoned- The new configuration setting for abandoned object tracking.
 
 - 
setRequireFullStackTracedefault void setRequireFullStackTrace(boolean requireFullStackTrace) Sets 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.- Parameters:
- requireFullStackTrace- the new configuration setting for abandoned object logging.
- Since:
- 2.7.0
 
 - 
startEvictionTestboolean startEvictionTest() Attempts to place the pooled object in thePooledObjectState.EVICTIONstate.- Returns:
- trueif the object was placed in the- PooledObjectState.EVICTIONstate otherwise- false.
 
 - 
toStringjava.lang.String toString() Gets a String form of the wrapper for debug purposes. The format is not fixed and may change at any time.- Overrides:
- toStringin class- java.lang.Object
 
 - 
usevoid use() Records the current stack trace as the last time the object was used.
 
- 
 
-