org.firebirdsql.gds.ng.ParameterConverter 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

There is a newer version: 6.0.0-beta-1

/*
 * 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.gds.ng;

import org.firebirdsql.gds.DatabaseParameterBuffer;
import org.firebirdsql.gds.ServiceParameterBuffer;

import java.sql.SQLException;

/**
 * Provides conversion of parameters (e.g. from {@link org.firebirdsql.gds.ng.IConnectionProperties} to a
 * {@link org.firebirdsql.gds.DatabaseParameterBuffer}).
 *
 * @author Mark Rotteveel
 * @since 3.0
 */
public interface ParameterConverter, S extends AbstractConnection> {

    /**
     * Builds a {@code DatabaseParameterBuffer} from the supplied {code IConnectionProperties}.
     *
     * @param connection
     *         Database connection
     * @return Database parameter buffer populated based on the connection properties
     * @throws SQLException For errors
     */
    DatabaseParameterBuffer toDatabaseParameterBuffer(D connection) throws SQLException;

    /**
     * Builds a {@code ServiceParameterBuffer} from the supplied {code IServiceProperties}.
     *
     * @param connection
     *         Service connection
     * @return Service parameter buffer populated based on the service properties
     * @throws SQLException For errors
     */
    ServiceParameterBuffer toServiceParameterBuffer(S connection) throws SQLException;
}