org.firebirdsql.jdbc.FBSQLException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation

JDBC Driver for the Firebird RDBMS

The newest version!

/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program 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
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc;

import java.io.Serial;
import java.sql.SQLException;

/**
 * @deprecated Unused, will be removed in Jaybird 7
 */
@SuppressWarnings("unused")
@Deprecated(since = "6", forRemoval = true)
public class FBSQLException extends SQLException {

    @Serial
    private static final long serialVersionUID = 8157410954186424083L;

    public FBSQLException(Exception ex) {
        this("Exception. " + ex.getMessage());
        initCause(ex);
    }

    public FBSQLException(String message) {
        super(message, SQLStateConstants.SQL_STATE_GENERAL_ERROR);
    }

    /**
     * @param message
     *         Exception message
     * @param sqlState
     *         SQL State for this exception. Replaced with {@link SQLStateConstants#SQL_STATE_GENERAL_ERROR} if null
     */
    public FBSQLException(String message, String sqlState) {
        super(message, defaultSQLStateIfNull(sqlState));
    }

    /**
     * @param sqlState
     *         SQL State value (or null)
     * @return The passed sqlState or {@link SQLStateConstants#SQL_STATE_GENERAL_ERROR} if sqlState is null.
     */
    public static String defaultSQLStateIfNull(String sqlState) {
        return sqlState != null ? sqlState : SQLStateConstants.SQL_STATE_GENERAL_ERROR;
    }
}