Java example source code file (RowSetWarning.java)

This example Java source code file (RowSetWarning.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

jdbc, rowsetwarning, sql, sqlexception, sqlstate

The RowSetWarning.java Java example source code

/*
 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.sql.rowset;

import java.sql.SQLException;

/**
 * An extension of <code>SQLException that provides information
 * about database warnings set on <code>RowSet objects.
 * Warnings are silently chained to the object whose method call
 * caused it to be reported.
 * This class complements the <code>SQLWarning class.
 * <P>
 * Rowset warnings may be retrieved from <code>JdbcRowSet,
 * <code>CachedRowSet™,
 * <code>WebRowSet, FilteredRowSet, or JoinRowSet
 * implementations. To retrieve the first warning reported on any
 * <code>RowSet
 * implementation,  use the method <code>getRowSetWarnings defined
 * in the <code>JdbcRowSet interface or the CachedRowSet
 * interface. To retrieve a warning chained to the first warning, use the
 * <code>RowSetWarning method
 * <code>getNextWarning. To retrieve subsequent warnings, call
 * <code>getNextWarning on each RowSetWarning object that is
 * returned.
 * <P>
 * The inherited methods <code>getMessage, getSQLState,
 * and <code>getErrorCode retrieve information contained in a
 * <code>RowSetWarning object.
 */
public class RowSetWarning extends SQLException {

    /**
     * RowSetWarning object handle.
     */
     private RowSetWarning rwarning;

    /**
     * Constructs a <code>RowSetWarning object
     * with the given value for the reason; SQLState defaults to null,
     * and vendorCode defaults to 0.
     *
     * @param reason a <code>String object giving a description
     *        of the warning; if the <code>String is null,
     *        this constructor behaves like the default (zero parameter)
     *        <code>RowSetWarning constructor
     */
    public RowSetWarning(String reason) {
        super(reason);
    }

    /**
     * Constructs a default <code>RowSetWarning object. The reason
     * defaults to <code>null, SQLState defaults to null and vendorCode
     * defaults to 0.
     */
    public RowSetWarning() {
        super();
    }

    /**
     * Constructs a <code>RowSetWarning object initialized with the
     * given values for the reason and SQLState. The vendor code defaults to 0.
     *
     * If the <code>reason or SQLState parameters are null,
     * this constructor behaves like the default (zero parameter)
     * <code>RowSetWarning constructor.
     *
     * @param reason a <code>String giving a description of the
     *        warning;
     * @param SQLState an XOPEN code identifying the warning; if a non standard
     *        XOPEN <i>SQLState is supplied, no exception is thrown.
     */
    public RowSetWarning(java.lang.String reason, java.lang.String SQLState) {
        super(reason, SQLState);
    }

    /**
     * Constructs a fully specified <code>RowSetWarning object initialized
     * with the given values for the reason, SQLState and vendorCode.
     *
     * If the <code>reason, or the  SQLState
     * parameters are <code>null, this constructor behaves like the default
     * (zero parameter) <code>RowSetWarning constructor.
     *
     * @param reason a <code>String giving a description of the
     *        warning;
     * @param SQLState an XOPEN code identifying the warning; if a non standard
     *        XPOEN <i>SQLState is supplied, no exception is thrown.
     * @param vendorCode a database vendor-specific warning code
     */
    public RowSetWarning(java.lang.String reason, java.lang.String SQLState, int vendorCode) {
        super(reason, SQLState, vendorCode);
    }

    /**
     * Retrieves the warning chained to this <code>RowSetWarning
     * object.
     *
     * @return the <code>RowSetWarning object chained to this one; if no
     *         <code>RowSetWarning object is chained to this one,
     *         <code>null is returned (default value)
     * @see #setNextWarning
     */
    public RowSetWarning getNextWarning() {
        return rwarning;
    }

    /**
     * Sets <i>warning as the next warning, that is, the warning chained
     * to this <code>RowSetWarning object.
     *
     * @param warning the <code>RowSetWarning object to be set as the
     *     next warning; if the <code>RowSetWarning is null, this
     *     represents the finish point in the warning chain
     * @see #getNextWarning
     */
    public void setNextWarning(RowSetWarning warning) {
        rwarning = warning;
    }

    static final long serialVersionUID = 6678332766434564774L;
}