org.firebirdsql.gds.ng.InfoProcessor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk17 Show documentation
JDBC Driver for the Firebird RDBMS
There is a newer version: 4.0.10.java7
/*
 * Public Firebird Java API.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. The name of the author may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.firebirdsql.gds.ng;

import org.firebirdsql.gds.ng.fields.RowDescriptor;

import java.sql.SQLException;

/**
 * Functional interface to process an information buffer (responses to p_info_*
 * requests) returning an object of type T.
 *
 * @param 
 *         Type of the result of the {@link #process(byte[])} method.
 * @author Mark Rotteveel
 * @since 3.0
 */
public interface InfoProcessor {

    /**
     * Process an infoResponse block into an object of type T.
     *
     * @param infoResponse
     *         byte array containing the server response to an info-request.
     * @return Processed response of type T (usually - but not required - a
     *         newly created object).
     * @throws SQLException
     *         For errors during the infoResponse.
     */
    T process(byte[] infoResponse) throws SQLException;

    /**
     * Interface for information on a statement.
     *
     * @author Mark Rotteveel
     * @since 3.0
     */
    interface StatementInfo {
        /**
         * @return The Statement Type
         */
        StatementType getStatementType();

        /**
         * @return RowDescriptor of the fields of the statement, never null
         */
        RowDescriptor getFields();

        /**
         * @return RowDescriptor of the parameters of the statement, never null
         */
        RowDescriptor getParameters();
    }
}