com.palantir.atlasdb.transaction.api.TransactionTask Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-api Show documentation
Show all versions of atlasdb-api Show documentation
Palantir open source project
/*
* (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
*
* 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.
*/
package com.palantir.atlasdb.transaction.api;
/**
* [TO COME: Interface Introduction].
*
* It is important that the {@link TransactionTask} does not modify any of its input state
* in any non-idempotent way. If this task gets retried, and if you modified your input, then the
* second try might not do the right thing. For example: if you are passed a list of objects
* and at the end of the {@link TransactionTask}, you clear the list. If your task gets retried
* it will have no work to do, because the list was cleared.
*/
public interface TransactionTask {
T execute(Transaction transaction) throws E;
}