rx.operators.OperationToObservableFuture Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava-core Show documentation
rxjava-core developed by Netflix
There is a newer version: 0.20.7
/**
 * Copyright 2014 Netflix, Inc.
 * 
 * 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 rx.operators;

import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

import rx.Observable.OnSubscribeFunc;
import rx.Observer;
import rx.Subscription;
import rx.subscriptions.Subscriptions;

/**
 * Converts a Future into an Observable.
 * 
 * 
 * 

 * You can convert any object that supports the Future interface into an Observable that emits the
 * return value of the get() method of that object, by using the from operation.
 * 
 * This is blocking so the Subscription returned when calling
 * Observable.subscribe(Observer) does nothing.
 */
public class OperationToObservableFuture {
    /* package accessible for unit tests */static class ToObservableFuture implements OnSubscribeFunc {
        private final Future that;
        private final Long time;
        private final TimeUnit unit;

        public ToObservableFuture(Future that) {
            this.that = that;
            this.time = null;
            this.unit = null;
        }

        public ToObservableFuture(Future that, long time, TimeUnit unit) {
            this.that = that;
            this.time = time;
            this.unit = unit;
        }

        @Override
        public Subscription onSubscribe(Observer observer) {
            try {
                T value = (time == null) ? (T) that.get() : (T) that.get(time, unit);

                if (!that.isCancelled()) {
                    observer.onNext(value);
                }
                observer.onCompleted();
            } catch (Throwable e) {
                observer.onError(e);
            }

            // the get() has already completed so there is no point in
            // giving the user a way to cancel.
            return Subscriptions.empty();
        }
    }

    public static  OnSubscribeFunc toObservableFuture(final Future that) {
        return new ToObservableFuture(that);
    }

    public static  OnSubscribeFunc toObservableFuture(final Future that, long time, TimeUnit unit) {
        return new ToObservableFuture(that, time, unit);
    }
}