org.androidtransfuse.transaction.Transaction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfuse-support Show documentation
The newest version!
/**
 * Copyright 2011-2015 John Ericksen
 *
 * 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 org.androidtransfuse.transaction;

/**
 * Transaction used to encapsulate work.
 *
 * @author John Ericksen
 */
public class Transaction implements Runnable {

    private final TransactionWorker worker;
    private final V value;
    private R result = null;
    private boolean complete = false;

    public Transaction(TransactionWorker worker) {
        this(null, worker);
    }

    public Transaction(V value, TransactionWorker worker) {
        this.value = value;
        this.worker = worker;
    }

    /**
     * Determines the status of the given work.
     *
     * @return complete
     */
    public boolean isComplete() {
        return complete && worker != null && worker.isComplete();
    }

    /**
     * Gets the value provided to this Transaction to run on.
     *
     * @return value
     */
    public V getValue() {
        return value;
    }

    /**
     * Gets the result (once complete) generated during the call to run().
     *
     * @return result
     */
    public R getResult() {
        return result;
    }

    /**
     * Returns the exception the caused the transaction to abort
     *
     * @return exception
     */
    public Exception getError() {
        return worker == null ? null : worker.getError();
    }

    @Override
    public void run() {
        result = worker.run(value);
        complete = true;
    }
}