All Downloads are FREE. Search and download functionalities are using the official Maven repository.

rx.singles.BlockingSingle Maven / Gradle / Ivy

There is a newer version: 1.3.8
Show newest version
/**
 * Copyright 2015 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.singles;

import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicReference;

import rx.*;
import rx.annotations.*;
import rx.exceptions.Exceptions;
import rx.internal.operators.BlockingOperatorToFuture;
import rx.internal.util.BlockingUtils;

/**
 * {@code BlockingSingle} is a blocking "version" of {@link Single} that provides blocking
 * operators.
 * 

* You construct a {@code BlockingSingle} from a {@code Single} with {@link #from(Single)} * or {@link Single#toBlocking()}. * * @param the value type of the sequence * @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number) */ @Beta public final class BlockingSingle { private final Single single; private BlockingSingle(Single single) { this.single = single; } /** * Converts a {@link Single} into a {@code BlockingSingle}. * * @param the value type of the sequence * @param single the {@link Single} you want to convert * @return a {@code BlockingSingle} version of {@code single} */ public static BlockingSingle from(Single single) { return new BlockingSingle(single); } /** * Returns the item emitted by this {@code BlockingSingle}. *

* If the underlying {@link Single} returns successfully, the value emitted * by the {@link Single} is returned. If the {@link Single} emits an error, * the throwable emitted ({@link SingleSubscriber#onError(Throwable)}) is * thrown. * * @return the value emitted by this {@code BlockingSingle} */ public T value() { final AtomicReference returnItem = new AtomicReference(); final AtomicReference returnException = new AtomicReference(); final CountDownLatch latch = new CountDownLatch(1); Subscription subscription = single.subscribe(new SingleSubscriber() { @Override public void onSuccess(T value) { returnItem.set(value); latch.countDown(); } @Override public void onError(Throwable error) { returnException.set(error); latch.countDown(); } }); BlockingUtils.awaitForComplete(latch, subscription); Throwable throwable = returnException.get(); if (throwable != null) { throw Exceptions.propagate(throwable); } return returnItem.get(); } /** * Returns a {@link Future} representing the value emitted by this {@code BlockingSingle}. * * @return a {@link Future} that returns the value */ @SuppressWarnings("unchecked") public Future toFuture() { return BlockingOperatorToFuture.toFuture(((Single)single).toObservable()); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy