javax.xml.xquery.XQConnectionEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright # 2003, 2004, 2005, 2006, 2007, 2008 Oracle.  All rights reserved.
 */

package javax.xml.xquery;

import java.util.EventObject;

/**
 * An event object that provides information about the
 * source of a connection-related event.  XQConnectionEvent
 * objects are generated when an application closes a pooled connection
 * and when an error occurs.  The XQConnectionEvent object
 * contains the folowing information:
 * 
 * The pooled connection closed by the application
 * 
In the case of an error, the XQException
 * to be thrown to the application
 * 
 */

public class XQConnectionEvent extends EventObject {

    /**
     * The XQException that will be thrown to the
     * application when an error occurs and the pooled connection is no
     * longer usable.
     */
    private XQException ex = null;

    /**
     * Constructs an XQConnectionEvent object initialized with
     * the given PooledXQConnection object. XQException
     * defaults to null.
     *
     * @param con the pooled connection that is the source of the event
     */
    public XQConnectionEvent(PooledXQConnection con) {
        super(con);
    }

    /**
     * Constructs an XQConnectionEvent object initialized with
     * the given PooledXQConnection object and
     * XQException object.
     *
     * @param con the pooled connection that is the source of the event
     * @param ex  the XQException to be thrown to the application
     */
    public XQConnectionEvent(PooledXQConnection con, XQException ex) {
        super(con);
        this.ex = ex;
    }

    /**
     * Retrieves the XQException for this
     * XQConnectionEvent object.
     *
     * @return the XQException to be thrown or null
     */
    public XQException getXQException() {
        return ex;
    }

}