org.firebirdsql.gds.impl.ParameterBufferMetaData 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 JavaEE Connector - 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.impl;

import org.firebirdsql.gds.ParameterBuffer;
import org.firebirdsql.gds.impl.argument.ArgumentType;

/**
 * Additional metadata for parameter buffer behavior.
 *
 * @author Mark Rotteveel
 * @since 3.0
 */
public interface ParameterBufferMetaData {

    /**
     * Parameter buffer type (this usually is the version of the parameter buffer).
     *
     * @return Buffer type (for example {@link org.firebirdsql.gds.ISCConstants#isc_spb_version3}).
     */
    int getType();

    /**
     * Allows the metadata to add a preamble to the parameter buffer.
     * 
     * This is only intended for the weird "version 2" connection service parameter buffer that requires two tags for
     * the version with {@code isc_spb_version, isc_spb_current_version}.
     * 
     *
     * @param parameterBuffer Parameter buffer.
     */
    default void addPreamble(ParameterBuffer parameterBuffer) {
        // Do nothing
    }

    /**
     * Gets the string argument type for the supplied tag.
     * 
     * When the tag is not known (or unsupported for string arguments), then the default should be returned.
     * 
     *
     * @param tag Tag (item type)
     * @return Argument type (never {@code null})
     */
    ArgumentType getStringArgumentType(int tag);

    /**
     * Gets the byte array argument type for the supplied tag.
     * 
     * When the tag is not known (or unsupported for string arguments), then the default should be returned.
     * 
     *
     * @param tag Tag (item type)
     * @return Argument type (never {@code null})
     */
    ArgumentType getByteArrayArgumentType(int tag);

    /**
     * Gets the integer argument type for the supplied tag.
     * 
     * When the tag is not known (or unsupported for string arguments), then the default should be returned.
     * 
     *
     * @param tag Tag (item type)
     * @return Argument type (never {@code null})
     */
    ArgumentType getIntegerArgumentType(int tag);

    /**
     * Gets the single argument type for the supplied tag.
     * 
     * When the tag is not known (or unsupported for string arguments), then the default should be returned.
     * 
     *
     * @param tag Tag (item type)
     * @return Argument type (never {@code null})
     */
    ArgumentType getSingleArgumentType(int tag);

    /**
     * Gets the byte argument type for the supplied tag.
     * 
     * When the tag is not known (or unsupported for string arguments), then the default should be returned.
     * 
     *
     * @param tag Tag (item type)
     * @return Argument type (never {@code null})
     */
    default ArgumentType getByteArgumentType(int tag) {
        return getIntegerArgumentType(tag);
    }

}