jetbrains.exodus.env.TransactionalComputable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation

Common library used by some SonarLint flavors

There is a newer version: 10.5.0.78949

/**
 * Copyright 2010 - 2022 JetBrains s.r.o.
 *
 * 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
 *
 * https://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 jetbrains.exodus.env;

import org.jetbrains.annotations.NotNull;

/**
 * A function that can pe passed to the {@linkplain Environment#computeInTransaction(TransactionalComputable)},
 * {@linkplain Environment#computeInReadonlyTransaction(TransactionalComputable)} or
 * {@linkplain Environment#computeInExclusiveTransaction(TransactionalComputable)} to be executed and return result
 * within a {@linkplain Transaction transaction}.
 *
 * @param  type of returned result
 * @see Transaction
 * @see Environment#computeInTransaction(TransactionalComputable)
 * @see Environment#computeInReadonlyTransaction(TransactionalComputable)
 * @see Environment#computeInExclusiveTransaction(TransactionalComputable)
 * @see TransactionalExecutable
 */
public interface TransactionalComputable {

    T compute(@NotNull final Transaction txn);
}