org.jooq.BindingGetResultSetContext Maven / Gradle / Ivy

Go to download

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

There is a newer version: 3.19.16

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import java.sql.ResultSet;

import org.jetbrains.annotations.NotNull;

/**
 * A container type for {@link Binding#get(BindingGetResultSetContext)}
 * arguments.
 *
 * @author Lukas Eder
 */
public interface BindingGetResultSetContext extends ExecuteScope, BindingScope {

    /**
     * The {@link ResultSet} from which a value is retrieved.
     */
    @NotNull
    ResultSet resultSet();

    /**
     * The column index at which the value is retrieved.
     */
    int index();

    /**
     * The {@link Field} at column index {@link #index()} whose value is
     * retrieved.
     */
    @NotNull
    Field field();

    /**
     * A callback to which the resulting value is registered.
     */
    void value(U value);

    /**
     * Create a new context from this one using a converter.
     */
    @NotNull
     BindingGetResultSetContext convert(Converter converter);
}