001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2023 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import javax.annotation.Nonnull;
020import java.util.Optional;
021
022/**
023 * Represents a transactional operation capable of returning a value.
024 * <p>
025 * See {@link TransactionalOperation} for a variant with a {@code void} return type.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 * @since 1.0.0
029 */
030@FunctionalInterface
031public interface ReturningTransactionalOperation<T> {
032        /**
033         * Executes a transactional operation.
034         *
035         * @return the result of operation execution
036         * @throws Exception if an error occurs while executing the transactional operation
037         */
038        @Nonnull
039        Optional<T> perform() throws Exception;
040}