hu.akarnokd.rxjava2.internal.subscribers.ConditionalSubscriber Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxjava2-backport Show documentation

rxjava2-backport developed by David Karnok

There is a newer version: 2.0.0-RC3

/**
 * Copyright 2015 David Karnok and 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 hu.akarnokd.rxjava2.internal.subscribers;

import org.reactivestreams.Subscriber;

/**
 * An Subscriber with an additional onNextIf(T) method that
 * tells the caller the specified value has been accepted or
 * not.
 * 
 * This allows certain queue-drain or source-drain operators
 * to avoid requesting 1 on behalf of a dropped value.
 * 
 * @param  the value type
 */
public interface ConditionalSubscriber extends Subscriber {
    /**
     * Conditionally takes the value.
     * @param t the value to deliver
     * @return true if the value has been accepted, false if the value has been rejected
     */
    boolean onNextIf(T t);
}