rx.subjects.TestSubject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rxjava Show documentation
rxjava
There is a newer version: 1.3.8
/**
 * 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.subjects;

import rx.Observer;
import rx.Scheduler;
import rx.functions.Action0;
import rx.functions.Action1;
import rx.internal.operators.NotificationLite;
import rx.schedulers.TestScheduler;
import rx.subjects.SubjectSubscriptionManager.SubjectObserver;

import java.util.concurrent.TimeUnit;

/**
 * A variety of Subject that is useful for testing purposes. It operates on a {@link TestScheduler} and allows
 * you to precisely time emissions and notifications to the Subject's subscribers using relative virtual time
 * controlled by the {@link TestScheduler}.
 *
 * @param 
 *          the type of item observed by and emitted by the subject
 */
public final class TestSubject extends Subject {
    private final SubjectSubscriptionManager state;
    private final Scheduler.Worker innerScheduler;


    /**
     * Creates and returns a new {@code TestSubject}.
     *
     * @param  the value type
     * @param scheduler a {@link TestScheduler} on which to operate this Subject
     * @return the new {@code TestSubject}
     */
    public static  TestSubject create(TestScheduler scheduler) {
        final SubjectSubscriptionManager state = new SubjectSubscriptionManager();

        state.onAdded = new Action1>() {

            @Override
            public void call(SubjectObserver o) {
                o.emitFirst(state.getLatest());
            }

        };
        state.onTerminated = state.onAdded;

        return new TestSubject(state, state, scheduler);
    }

    protected TestSubject(OnSubscribe onSubscribe, SubjectSubscriptionManager state, TestScheduler scheduler) {
        super(onSubscribe);
        this.state = state;
        this.innerScheduler = scheduler.createWorker();
    }

    /**
     * Schedule a call to {@code onCompleted} on TestScheduler.
     */
    @Override
    public void onCompleted() {
        onCompleted(0);
    }

    void internalOnCompleted() {
        if (state.active) {
            for (SubjectObserver bo : state.terminate(NotificationLite.completed())) {
                bo.onCompleted();
            }
        }
    }

    /**
     * Schedule a call to {@code onCompleted} relative to "now()" +n milliseconds in the future.
     *
     * @param delayTime
     *         the number of milliseconds in the future relative to "now()" at which to call {@code onCompleted}
     */
    public void onCompleted(long delayTime) {
        innerScheduler.schedule(new Action0() {

            @Override
            public void call() {
                internalOnCompleted();
            }

        }, delayTime, TimeUnit.MILLISECONDS);
    }

    /**
     * Schedule a call to {@code onError} on TestScheduler.
     */
    @Override
    public void onError(final Throwable e) {
        onError(e, 0);
    }

    void internalOnError(final Throwable e) {
        if (state.active) {
            for (SubjectObserver bo : state.terminate(NotificationLite.error(e))) {
                bo.onError(e);
            }
        }
    }

    /**
     * Schedule a call to {@code onError} relative to "now()" +n milliseconds in the future.
     *
     * @param e
     *         the {@code Throwable} to pass to the {@code onError} method
     * @param delayTime
     *         the number of milliseconds in the future relative to "now()" at which to call {@code onError}
     */
    public void onError(final Throwable e, long delayTime) {
        innerScheduler.schedule(new Action0() {

            @Override
            public void call() {
                internalOnError(e);
            }

        }, delayTime, TimeUnit.MILLISECONDS);
    }

    /**
     * Schedule a call to {@code onNext} on TestScheduler.
     */
    @Override
    public void onNext(T v) {
        onNext(v, 0);
    }

    void internalOnNext(T v) {
        for (Observer o : state.observers()) {
            o.onNext(v);
        }
    }

    /**
     * Schedule a call to {@code onNext} relative to "now()" +n milliseconds in the future.
     *
     * @param v
     *         the item to emit
     * @param delayTime
     *         the number of milliseconds in the future relative to "now()" at which to call {@code onNext}
     */
    public void onNext(final T v, long delayTime) {
        innerScheduler.schedule(new Action0() {

            @Override
            public void call() {
                internalOnNext(v);
            }

        }, delayTime, TimeUnit.MILLISECONDS);
    }

    @Override
    public boolean hasObservers() {
        return state.observers().length > 0;
    }
}