io.reactivex.observable.SingleOperator Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2016-present, RxJava Contributors.
 *
 * 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 io.reactivex.observable;

import io.reactivex.common.annotations.NonNull;

/**
 * Interface to map/wrap a downstream observer to an upstream observer.
 *
 * @param  the value type of the downstream
 * @param  the value type of the upstream
 */
public interface SingleOperator {
    /**
     * Applies a function to the child SingleObserver and returns a new parent SingleObserver.
     * @param observer the child SingleObserver instance
     * @return the parent SingleObserver instance
     * @throws Exception on failure
     */
    @NonNull
    SingleObserver apply(@NonNull SingleObserver observer) throws Exception;
}