/*

 * Copyright 1996-2006 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package java.sql;

/**

 * <P>An exception that provides information on  database access

 * warnings. Warnings are silently chained to the object whose method

 * caused it to be reported.

 * <P>

 * Warnings may be retrieved from <code>Connection</code>, <code>Statement</code>,

 * and <code>ResultSet</code> objects.  Trying to retrieve a warning on a

 * connection after it has been closed will cause an exception to be thrown.

 * Similarly, trying to retrieve a warning on a statement after it has been

 * closed or on a result set after it has been closed will cause

 * an exception to be thrown. Note that closing a statement also

 * closes a result set that it might have produced.

 *

 * @see Connection#getWarnings

 * @see Statement#getWarnings

 * @see ResultSet#getWarnings

 */

public class SQLWarning extends SQLException {

    /**

     * Constructs a  <code>SQLWarning</code> object

     *  with a given <code>reason</code>, <code>SQLState</code>  and

     * <code>vendorCode</code>.

     *

     * The <code>cause</code> is not initialized, and may subsequently be

     * initialized by a call to the

     * {@link Throwable#initCause(java.lang.Throwable)} method.

     * <p>

     * @param reason a description of the warning

     * @param SQLState an XOPEN or SQL:2003 code identifying the warning

     * @param vendorCode a database vendor-specific warning code

     */

     public SQLWarning(String reason, String SQLState, int vendorCode) {

        super(reason, SQLState, vendorCode);

        DriverManager.println("SQLWarning: reason(" + reason +

                              ") SQLState(" + SQLState +

                              ") vendor code(" + vendorCode + ")");

    }

    /**

     * Constructs a <code>SQLWarning</code> object

     * with a given <code>reason</code> and <code>SQLState</code>.

     *

     * The <code>cause</code> is not initialized, and may subsequently be

     * initialized by a call to the

     * {@link Throwable#initCause(java.lang.Throwable)} method. The vendor code

     * is initialized to 0.

     * <p>

     * @param reason a description of the warning

     * @param SQLState an XOPEN or SQL:2003 code identifying the warning

     */

    public SQLWarning(String reason, String SQLState) {

        super(reason, SQLState);

        DriverManager.println("SQLWarning: reason(" + reason +

                                  ") SQLState(" + SQLState + ")");

    }

    /**

     * Constructs a <code>SQLWarning</code> object

     * with a given <code>reason</code>. The <code>SQLState</code>

     * is initialized to <code>null</code> and the vender code is initialized

     * to 0.

     *

     * The <code>cause</code> is not initialized, and may subsequently be

     * initialized by a call to the

     * {@link Throwable#initCause(java.lang.Throwable)} method.

     * <p>

     * @param reason a description of the warning

     */

    public SQLWarning(String reason) {

        super(reason);

        DriverManager.println("SQLWarning: reason(" + reason + ")");

    }

    /**

     * Constructs a  <code>SQLWarning</code> object.

     * The <code>reason</code>, <code>SQLState</code> are initialized

     * to <code>null</code> and the vendor code is initialized to 0.

     *

     * The <code>cause</code> is not initialized, and may subsequently be

     * initialized by a call to the

     * {@link Throwable#initCause(java.lang.Throwable)} method.

     * <p>

     */

    public SQLWarning() {

        super();

        DriverManager.println("SQLWarning: ");

    }

    /**

     * Constructs a <code>SQLWarning</code> object

     * with a given  <code>cause</code>.

     * The <code>SQLState</code> is initialized

     * to <code>null</code> and the vendor code is initialized to 0.

     * The <code>reason</code>  is initialized to <code>null</code> if

     * <code>cause==null</code> or to <code>cause.toString()</code> if

     * <code>cause!=null</code>.

     * <p>

     * @param cause the underlying reason for this <code>SQLWarning</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating

     *     the cause is non-existent or unknown.

     */

    public SQLWarning(Throwable cause) {

        super(cause);

        DriverManager.println("SQLWarning");

    }

    /**

     * Constructs a <code>SQLWarning</code> object

     * with a given

     * <code>reason</code> and  <code>cause</code>.

     * The <code>SQLState</code> is  initialized to <code>null</code>

     * and the vendor code is initialized to 0.

     * <p>

     * @param reason a description of the warning

     * @param cause  the underlying reason for this <code>SQLWarning</code>

     * (which is saved for later retrieval by the <code>getCause()</code> method);

     * may be null indicating the cause is non-existent or unknown.

     */

    public SQLWarning(String reason, Throwable cause) {

        super(reason,cause);

        DriverManager.println("SQLWarning : reason("+ reason + ")");

    }

    /**

     * Constructs a <code>SQLWarning</code> object

     * with a given

     * <code>reason</code>, <code>SQLState</code> and  <code>cause</code>.

     * The vendor code is initialized to 0.

     * <p>

     * @param reason a description of the warning

     * @param SQLState an XOPEN or SQL:2003 code identifying the warning

     * @param cause the underlying reason for this <code>SQLWarning</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating

     *     the cause is non-existent or unknown.

     */

    public SQLWarning(String reason, String SQLState, Throwable cause) {

        super(reason,SQLState,cause);

        DriverManager.println("SQLWarning: reason(" + reason +

                                  ") SQLState(" + SQLState + ")");

    }

    /**

     * Constructs a<code>SQLWarning</code> object

     * with a given

     * <code>reason</code>, <code>SQLState</code>, <code>vendorCode</code>

     * and  <code>cause</code>.

     * <p>

     * @param reason a description of the warning

     * @param SQLState an XOPEN or SQL:2003 code identifying the warning

     * @param vendorCode a database vendor-specific warning code

     * @param cause the underlying reason for this <code>SQLWarning</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating

     *     the cause is non-existent or unknown.

     */

    public SQLWarning(String reason, String SQLState, int vendorCode, Throwable cause) {

        super(reason,SQLState,vendorCode,cause);

        DriverManager.println("SQLWarning: reason(" + reason +

                              ") SQLState(" + SQLState +

                              ") vendor code(" + vendorCode + ")");

    }

    /**

     * Retrieves the warning chained to this <code>SQLWarning</code> object by

     * <code>setNextWarning</code>.

     *

     * @return the next <code>SQLException</code> in the chain; <code>null</code> if none

     * @see #setNextWarning

     */

    public SQLWarning getNextWarning() {

        try {

            return ((SQLWarning)getNextException());

        } catch (ClassCastException ex) {

            // The chained value isn't a SQLWarning.

            // This is a programming error by whoever added it to

            // the SQLWarning chain.  We throw a Java "Error".

            throw new Error("SQLWarning chain holds value that is not a SQLWarning");

        }

    }

    /**

     * Adds a <code>SQLWarning</code> object to the end of the chain.

     *

     * @param w the new end of the <code>SQLException</code> chain

     * @see #getNextWarning

     */

    public void setNextWarning(SQLWarning w) {

        setNextException(w);

    }

    private static final long serialVersionUID = 3917336774604784856L;

}