001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 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 org.jspecify.annotations.NonNull;
020
021import java.util.Optional;
022
023/**
024 * Represents a transactional operation capable of returning a value.
025 * <p>
026 * See {@link TransactionalOperation} for a variant with a {@code void} return type.
027 *
028 * @author <a href="https://www.revetkn.com">Mark Allen</a>
029 * @since 1.0.0
030 */
031@FunctionalInterface
032public interface ReturningTransactionalOperation<T> {
033        /**
034         * Executes a transactional operation.
035         *
036         * @return the result of operation execution
037         * @throws Exception if an error occurs while executing the transactional operation
038         */
039        @NonNull
040        Optional<T> perform() throws Exception;
041}