Debian Codegraph @

src/main/java/io/reactivex/rxjava3/core/CompletableConverter.java

raw
1 /*
2 * Copyright (c) 2016-present, RxJava Contributors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
5 * compliance with the License. You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software distributed under the License is
10 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
11 * the License for the specific language governing permissions and limitations under the License.
12 */
13
14 package io.reactivex.rxjava3.core;
15
16 import io.reactivex.rxjava3.annotations.NonNull;
17
18 /**
19 * Convenience interface and callback used by the {@link Completable#to} operator to turn a Completable into another
20 * value fluently.
21 * <p>History: 2.1.7 - experimental
22 * @param <R> the output type
23 * @since 2.2
24 */
25 @FunctionalInterface
26 public interface CompletableConverter<@NonNull R> {
27 /**
28 * Applies a function to the upstream Completable and returns a converted value of type {@code R}.
29 *
30 * @param upstream the upstream Completable instance
31 * @return the converted value
32 */
33 R apply(@NonNull Completable upstream);
34 }