org.skife.jdbi.v2.tweak.HandleCallback Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004-2014 Brian McCallister
 * Copyright 2010-2014 Ning, Inc.
 * Copyright 2014-2020 Groupon, Inc
 * Copyright 2020-2020 Equinix, Inc
 * Copyright 2014-2020 The Billing Project, LLC
 *
 * The Billing Project licenses this file to you 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.
 */
package org.skife.jdbi.v2.tweak;

import org.skife.jdbi.v2.Handle;

/**
 * Callback for use with {@link org.skife.jdbi.v2.DBI#withHandle(HandleCallback)}
 */
public interface HandleCallback
{
    /**
     * Will be invoked with an open Handle. The handle will be closed when this
     * callback returns. Any exception thrown will be wrapped in a
     * {@link org.skife.jdbi.v2.exceptions.CallbackFailedException}
     *
     * @param handle Handle to be used only within scope of this callback
     * @return The return value of the callback
     * @throws Exception will result in a {@link org.skife.jdbi.v2.exceptions.CallbackFailedException} wrapping
     *                   the exception being thrown
     */
    T withHandle(Handle handle) throws Exception;
}