VMSyncFuture.java

/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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.spf4j.zel.vm;

import com.google.common.base.Throwables;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import javax.annotation.concurrent.ThreadSafe;
import org.spf4j.base.Either;

/**
 * bean like implementation of a future
 * @author zoly
 */
@ThreadSafe
@SuppressFBWarnings("NOS_NON_OWNED_SYNCHRONIZATION")
public class VMSyncFuture<T> implements VMFuture<T> {
    private volatile Either<T, ? extends ExecutionException> result;

    @Override
    public final boolean cancel(final boolean mayInterruptIfRunning) {
        throw new UnsupportedOperationException();
    }

    @Override
    public final boolean isCancelled() {
        throw new UnsupportedOperationException();
    }

    @Override
    public final boolean isDone() {
        return result != null;
    }

    @Override
    @SuppressFBWarnings
    public final Either<T, ? extends ExecutionException> getResult() {
        return result;
    }

    public final synchronized T get() throws InterruptedException, ExecutionException {
        while (result == null) {
            this.wait(1000);
        }
        return Either.processResult(result);
    }

    @Override
    public final T get(final long timeout, final TimeUnit unit)
            throws InterruptedException, ExecutionException, TimeoutException {
        long timeoutMillis = unit.toMillis(timeout);
        long toWait = timeoutMillis;
        long startTime = System.currentTimeMillis();
        synchronized (this) {
            while (toWait > 0 && result == null) {
                this.wait(toWait);
                toWait = timeoutMillis - (System.currentTimeMillis() - startTime);
            }
            if (result == null) {
                throw new TimeoutException("Timed out after " + timeout + " " + unit);
            }
            return Either.processResult(result);
        }
    }

    @Override
    public final synchronized void setResult(final T presult) {
        if (this.result != null) {
            throw new IllegalStateException("cannot set " + result + " result multiple times");
        }
        this.result = Either.left(presult);
        this.notifyAll();
    }

    @Override
    public final synchronized void setExceptionResult(final ExecutionException eresult) {
        if (Throwables.getRootCause(eresult) == ExecAbortException.INSTANCE) {
            return;
        }
        if (this.result != null) {
            throw new IllegalStateException("cannot set result " + result + " multiple times");
        }
        this.result = Either.right(eresult);
        this.notifyAll();
    }

    @Override
    public final String toString() {
        return "VMSyncFuture{" + "result=" + result + '}';
    }

}