StatementEvent

AI-generated Key Takeaways

• StatementEvent is triggered when a PreparedStatement associated with a PooledConnection is closed or becomes invalid.

• This event is sent to all registered StatementEventListeners.

• It provides access to the associated PreparedStatement and any potential SQLException.

• The event is constructed with the related PooledConnection and PreparedStatement.

• A SQLException can optionally be included during event construction to indicate an error.

public class StatementEvent extends EventObject

A StatementEvent is sent to all StatementEventListeners which were registered with a PooledConnection. This occurs when the driver determines that a PreparedStatement that is associated with the PooledConnection has been closed or the driver determines is invalid.

Inherited Field Summary

From class java.util.EventObject

protected Object

source

The object on which the Event initially occurred.

Public Constructor Summary

	StatementEvent(PooledConnection con, PreparedStatement statement) Constructs a StatementEvent with the specified PooledConnection and PreparedStatement.
	StatementEvent(PooledConnection con, PreparedStatement statement, SQLException exception) Constructs a StatementEvent with the specified PooledConnection, PreparedStatement and SQLException

Public Method Summary

SQLException	getSQLException() Returns the SQLException the driver is about to throw
PreparedStatement	getStatement() Returns the PreparedStatement that is being closed or is invalid

Inherited Method Summary

From class java.util.EventObject

Object	getSource() The object on which the Event initially occurred.
String	toString() Returns a String representation of this EventObject.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public StatementEvent (PooledConnection con, PreparedStatement statement)

Constructs a StatementEvent with the specified PooledConnection and PreparedStatement. The SQLException contained in the event defaults to null.

Parameters

con	The PooledConnection that the closed or invalid PreparedStatementis associated with.
statement	The PreparedStatement that is bieng closed or is invalid

Throws

IllegalArgumentException	if con is null.

public StatementEvent (PooledConnection con, PreparedStatement statement, SQLException exception)

Constructs a StatementEvent with the specified PooledConnection, PreparedStatement and SQLException

Parameters

con	The PooledConnection that the closed or invalid PreparedStatement is associated with.
statement	The PreparedStatement that is being closed or is invalid
exception	The SQLException the driver is about to throw to the application

Throws

IllegalArgumentException	if con is null.

Public Methods

public SQLException getSQLException ()

Returns the SQLException the driver is about to throw

Returns

• The SQLException the driver is about to throw

public PreparedStatement getStatement ()

Returns the PreparedStatement that is being closed or is invalid

Returns

• The PreparedStatement that is being closed or is invalid