snaq.util

Class ObjectPoolEvent<T extends Reusable>

java.lang.Object

java.util.EventObject

snaq.util.ObjectPoolEvent<T>

Type Parameters:

T - class type of referring ObjectPool

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConnectionPoolEvent

public class ObjectPoolEvent<T extends Reusable>
extends EventObject

Event for ObjectPool instances. Convenience methods are available for determining the type of the event, and the event is capable of keeping shadow copies of the pool's vital parameters at the time the event was issued, for reference to listeners.

Author:

Giles Winstanley

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectPoolEvent.Type Enumeration of event types.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ObjectPoolEvent(ObjectPool<T> pool, ObjectPoolEvent.Type type) Creates a new PoolEvent.

Method Summary

Modifier and Type	Method and Description
int	getCheckedOut()
int	getFreeCount()
long	getIdleTimeout()
int	getMaxPool()
int	getMaxSize()
int	getMinPool()
ObjectPool<T>	getPool() Returns the pool for which this event was created.
float	getPoolHitRate()
int	getSize()
ObjectPoolEvent.Type	getType() Returns the type of event this object represents.
String	getTypeString() Returns the type of event this object represents as a string.
boolean	isMaxPoolLimitExceeded()
boolean	isMaxPoolLimitReached()
boolean	isMaxSizeLimitError()
boolean	isMaxSizeLimitReached()
boolean	isPoolCheckIn()
boolean	isPoolCheckOut()
boolean	isPoolFlushed()
boolean	isPoolInitCompleted()
boolean	isPoolParametersChanged()
boolean	isPoolReleased()
boolean	isValidationError()
String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectPoolEvent

public ObjectPoolEvent(ObjectPool<T> pool,
                       ObjectPoolEvent.Type type)

Creates a new PoolEvent.

Parameters:

pool - ObjectPool for which to create event

type - type of event to create

Method Detail

getPool

public ObjectPool<T> getPool()

Returns the pool for which this event was created.

Returns:

The pool for which this event was created

getType

public ObjectPoolEvent.Type getType()

Returns the type of event this object represents.

Returns:

The type of event this object represents

getTypeString

public String getTypeString()

Returns the type of event this object represents as a string.

Returns:

The type of event this object represents as a string

toString

public String toString()

Overrides:

toString in class EventObject

isPoolInitCompleted

public boolean isPoolInitCompleted()

isPoolCheckOut

public boolean isPoolCheckOut()

isPoolCheckIn

public boolean isPoolCheckIn()

isValidationError

public boolean isValidationError()

isMaxPoolLimitReached

public boolean isMaxPoolLimitReached()

isMaxPoolLimitExceeded

public boolean isMaxPoolLimitExceeded()

isMaxSizeLimitReached

public boolean isMaxSizeLimitReached()

isMaxSizeLimitError

public boolean isMaxSizeLimitError()

isPoolParametersChanged

public boolean isPoolParametersChanged()

isPoolFlushed

public boolean isPoolFlushed()

isPoolReleased

public boolean isPoolReleased()

getMinPool

public int getMinPool()

getMaxPool

public int getMaxPool()

getMaxSize

public int getMaxSize()

getIdleTimeout

public long getIdleTimeout()

getCheckedOut

public int getCheckedOut()

getFreeCount

public int getFreeCount()

getSize

public int getSize()

getPoolHitRate

public float getPoolHitRate()