Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.pool2.impl
Class DefaultPooledObject<T>

java.lang.Object
  extended by org.apache.commons.pool2.impl.DefaultPooledObject<T>
Type Parameters:
T - the type of object in the pool
All Implemented Interfaces:
Comparable<PooledObject<T>>, PooledObject<T>
Direct Known Subclasses:
PooledSoftReference
public class DefaultPooledObject<T>
extends Object
implements PooledObject<T>

This wrapper is used to track the additional information, such as state, for the pooled objects.

This class is intended to be thread-safe.

Since:
2.0
Version:
$Revision: $

Constructor Summary
DefaultPooledObject(T object)
          Create a new instance that wraps the provided object so that the pool can track the state of the pooled object.
 
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.
 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 getBorrowedCount()
          Get the number of times this object has been borrowed.
 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.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.pool2.PooledObject
equals, hashCode
 

Constructor Detail

DefaultPooledObject

public DefaultPooledObject(T object)
Create a new instance that wraps the provided object so that the pool can track the state of the pooled object.

Parameters:
object - The object to wrap
Method Detail

getObject

public T getObject()
Description copied from interface: PooledObject
Obtain the underlying object that is wrapped by this instance of PooledObject.

Specified by:
getObject in interface PooledObject<T>
Returns:
The wrapped object

getCreateTime

public long getCreateTime()
Description copied from interface: PooledObject
Obtain the time (using the same basis as System.currentTimeMillis()) that this object was created.

Specified by:
getCreateTime in interface PooledObject<T>
Returns:
The creation time for the wrapped object

getActiveTimeMillis

public long getActiveTimeMillis()
Description copied from interface: PooledObject
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).

Specified by:
getActiveTimeMillis in interface PooledObject<T>
Returns:
The time in milliseconds last spent in the active state

getIdleTimeMillis

public long getIdleTimeMillis()
Description copied from interface: PooledObject
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).

Specified by:
getIdleTimeMillis in interface PooledObject<T>
Returns:
The time in milliseconds last spent in the idle state

getLastBorrowTime

public long getLastBorrowTime()
Description copied from interface: PooledObject
Obtain the time the wrapped object was last borrowed.

Specified by:
getLastBorrowTime in interface PooledObject<T>
Returns:
The time the object was last borrowed

getLastReturnTime

public long getLastReturnTime()
Description copied from interface: PooledObject
Obtain the time the wrapped object was last returned.

Specified by:
getLastReturnTime in interface PooledObject<T>
Returns:
The time the object was last returned

getBorrowedCount

public long getBorrowedCount()
Get the number of times this object has been borrowed.

Returns:
The number of times this object has been borrowed.
Since:
2.1

getLastUsedTime

public long getLastUsedTime()
Return 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().

Specified by:
getLastUsedTime in interface PooledObject<T>
Returns:
the last time this object was used

compareTo

public int compareTo(PooledObject<T> other)
Description copied from interface: PooledObject
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:
compareTo in interface Comparable<PooledObject<T>>
Specified by:
compareTo in interface PooledObject<T>

toString

public String toString()
Description copied from interface: PooledObject
Provides a String form of the wrapper for debug purposes. The format is not fixed and may change at any time.

Specified by:
toString in interface PooledObject<T>
Overrides:
toString in class Object

startEvictionTest

public boolean startEvictionTest()
Description copied from interface: PooledObject
Attempt to place the pooled object in the PooledObjectState.EVICTION state.

Specified by:
startEvictionTest in interface PooledObject<T>
Returns:
true if the object was placed in the PooledObjectState.EVICTION state otherwise false

endEvictionTest

public boolean endEvictionTest(Deque<PooledObject<T>> idleQueue)
Description copied from interface: PooledObject
Called to inform the object that the eviction test has ended.

Specified by:
endEvictionTest in interface PooledObject<T>
Parameters:
idleQueue - The queue if idle objects to which the object should be returned
Returns:
Currently not used

allocate

public boolean allocate()
Allocates the object.

Specified by:
allocate in interface PooledObject<T>
Returns:
true if the original state was IDLE

deallocate

public boolean deallocate()
Deallocates the object and sets it IDLE if it is currently ALLOCATED.

Specified by:
deallocate in interface PooledObject<T>
Returns:
true if the state was ALLOCATED

invalidate

public void invalidate()
Sets the state to INVALID

Specified by:
invalidate in interface PooledObject<T>

use

public void use()
Description copied from interface: PooledObject
Record the current stack trace as the last time the object was used.

Specified by:
use in interface PooledObject<T>

printStackTrace

public void printStackTrace(PrintWriter writer)
Description copied from interface: PooledObject
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.

Specified by:
printStackTrace in interface PooledObject<T>
Parameters:
writer - The destination for the debug output

getState

public PooledObjectState getState()
Returns the state of this object.

Specified by:
getState in interface PooledObject<T>
Returns:
state

markAbandoned

public void markAbandoned()
Marks the pooled object as abandoned.

Specified by:
markAbandoned in interface PooledObject<T>

markReturning

public void markReturning()
Marks the object as returning to the pool.

Specified by:
markReturning in interface PooledObject<T>

setLogAbandoned

public void setLogAbandoned(boolean logAbandoned)
Description copied from interface: PooledObject
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.

Specified by:
setLogAbandoned in interface PooledObject<T>
Parameters:
logAbandoned - The new configuration setting for abandoned object tracking
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001–2014 The Apache Software Foundation. All rights reserved.