org.firebirdsql.gds.TransactionParameterBuffer 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!
/*
 * 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;

import static org.firebirdsql.jaybird.fb.constants.TpbItems.isc_tpb_autocommit;
import static org.firebirdsql.jaybird.fb.constants.TpbItems.isc_tpb_read;
import static org.firebirdsql.jaybird.fb.constants.TpbItems.isc_tpb_write;

/**
 * Instances of this interface represent Transaction Parameter Buffer from the Firebird API.
 */
public interface TransactionParameterBuffer extends ParameterBuffer {

    /**
     * Make a deep copy of this object.
     *
     * @return deep copy of this object.
     */
    TransactionParameterBuffer deepCopy();

    /**
     * Copies the contents of this transaction parameter buffer to {@code destination}.
     *
     * @param destination destination transaction parameter buffer
     * @since 6
     */
    default void copyTo(TransactionParameterBuffer destination) {
        for (Parameter parameter : this) {
            parameter.copyTo(destination, null);
        }
    }

    /**
     * Set the read-only flag ({@code isc_tpb_read}) or read/write flag ({@code isc_tpb_write}) on this TPB.
     *
     * @param readOnly
     *         if {@code true}, this TPB will be set to read-only, otherwise it will be read/write
     * @since 6
     */
    default void setReadOnly(boolean readOnly) {
        if (readOnly) {
            ensurePresentAbsent(isc_tpb_read, isc_tpb_write);
        } else {
            ensurePresentAbsent(isc_tpb_write, isc_tpb_read);
        }
    }

    private void ensurePresentAbsent(int present, int absent) {
        if (!hasArgument(present)) {
            addArgument(present);
        }
        removeArgument(absent);
    }

    /**
     * Determine whether this TPB is set to read-only.
     *
     * @return {@code true} if this TPB is read-only, otherwise {@code false}
     * @since 6
     */
    default boolean isReadOnly() {
        return hasArgument(isc_tpb_read);
    }

    /**
     * Sets the Firebird auto-commit flag on this TPB.
     * 
     * This shouldn't be confused with the normal JDBC auto-commit behavior. Effectively, setting this to {@code true}
     * will result in Firebird using commit retain after each executed statement.
     * 
     *
     * @param autoCommit
     *         {@code true} add the auto-commit flag, otherwise remove it
     * @see #isAutoCommit()
     * @since 6
     */
    default void setAutoCommit(boolean autoCommit) {
        if (autoCommit) {
            if (!hasArgument(isc_tpb_autocommit)) {
                addArgument(isc_tpb_autocommit);
            }
        } else {
            removeArgument(isc_tpb_autocommit);
        }
    }

    /**
     * Returns if this TPB has the auto-commit flag set.
     *
     * @return {@code true} if this TPB has the auto-commit flag, {@code false} otherwise
     * @see #setAutoCommit(boolean)
     * @since 6
     */
    default boolean isAutoCommit() {
        return hasArgument(isc_tpb_autocommit);
    }

}