/*
 * Copyright 2008-present MongoDB, 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 com.mongodb.async.client;

import com.mongodb.Block;
import com.mongodb.async.SingleResultCallback;

import java.util.List;


Observable helpers.
Allows async methods to be converted into event-based Observables.
Since:
3.1
Deprecated:
Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)/**
 * Observable helpers.
 *
 * <p>Allows async methods to be converted into event-based {@link Observable}s.</p>
 *
 * @since 3.1
 * @deprecated Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)
 */
@Deprecated
public final class Observables {

    
Convert a MongoIterable into an Observable. 
Params:
mongoIterable – the MongoIterable to subscribe to
Type parameters:
<TResult> –     The type of result being observed
Returns:
the observable version of the mongoIterable/**
     * Convert a {@link MongoIterable} into an {@link Observable}.
     *
     * @param mongoIterable the MongoIterable to subscribe to
     * @param <TResult>     The type of result being observed
     * @return the observable version of the mongoIterable
     */
    public static <TResult> Observable<TResult> observe(final MongoIterable<TResult> mongoIterable) {
        return new Observable<TResult>() {
            @Override
            public void subscribe(final Observer<? super TResult> observer) {
                new MongoIterableSubscription<TResult>(mongoIterable, observer);
            }
        };
    }

    
Allows the conversion of SingleResultCallback based operations into an Observable 
Requires a Block that is passed the callback to be used with the operation. This is required to make sure that the operation only occurs once the Subscription signals for data.

A typical example would be when wrapping callback based methods to make them observable. 
 For example, converting MongoCollection.count(SingleResultCallback) into an Observable: 

   Observable<Long> countObservable = observe(new Block<SingleResultCallback<Long>>() {
       public void apply(final SingleResultCallback<Long> callback) {
           collection.countDocuments(callback);
       }
   });
 
Params:
operation – the block that implements the operation.
Type parameters:
<TResult> – The type of result being observed
Returns:
the observable version of the callback based operation/**
     * Allows the conversion of {@link SingleResultCallback} based operations into an {@link Observable}
     *
     * <p>Requires a {@link Block} that is passed the callback to be used with the operation.
     * This is required to make sure that the operation only occurs once the {@link Subscription} signals for data.</p>
     * <p>
     * A typical example would be when wrapping callback based methods to make them observable. <br>
     * For example, converting {@link MongoCollection#count(SingleResultCallback)} into an {@link Observable}:
     * <pre>
     * {@code
     *    Observable<Long> countObservable = observe(new Block<SingleResultCallback<Long>>() {
     *        public void apply(final SingleResultCallback<Long> callback) {
     *            collection.countDocuments(callback);
     *        }
     *    });
     * }
     * </pre>
     *
     * @param operation the block that implements the operation.
     * @param <TResult> The type of result being observed
     * @return the observable version of the callback based operation
     */
    public static <TResult> Observable<TResult> observe(final Block<SingleResultCallback<TResult>> operation) {
        return new Observable<TResult>() {
            @Override
            public void subscribe(final Observer<? super TResult> observer) {
                new SingleResultCallbackSubscription<TResult>(operation, observer);
            }
        };
    }

    
Allows the conversion of SingleResultCallback based operations and flattens the results in an Observable. 
Requires a Block that is passed the callback to be used with the operation. This is required to make sure that the operation only occurs once the Subscription signals for data.
Params:
operation – the operation that is passed a callback and is used to delay execution of an operation until demanded.
Type parameters:
<TResult> – The type of result being observed
Returns:
a subscription/**
     * Allows the conversion of {@link SingleResultCallback} based operations and flattens the results in an {@link Observable}.
     *
     * <p>Requires a {@link Block} that is passed the callback to be used with the operation.
     * This is required to make sure that the operation only occurs once the {@link Subscription} signals for data.</p>
     *
     * @param operation the operation that is passed a callback and is used to delay execution of an operation until demanded.
     * @param <TResult> The type of result being observed
     * @return a subscription
     */
    public static <TResult> Observable<TResult> observeAndFlatten(final Block<SingleResultCallback<List<TResult>>> operation) {
        return new Observable<TResult>() {
            @Override
            public void subscribe(final Observer<? super TResult> observer) {
                new FlatteningSingleResultCallbackSubscription<TResult>(operation, observer);
            }
        };
    }

    private Observables() {
    }
}