Debian Codegraph @

src/main/java/io/reactivex/rxjava3/schedulers/SchedulerRunnableIntrospection.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.schedulers;
15
16 import io.reactivex.rxjava3.annotations.NonNull;
17 import io.reactivex.rxjava3.functions.Function;
18 import io.reactivex.rxjava3.plugins.RxJavaPlugins;
19
20 /**
21 * Interface to indicate the implementor class wraps a {@code Runnable} that can
22 * be accessed via {@link #getWrappedRunnable()}.
23 * <p>
24 * You can check if a {@link Runnable} task submitted to a {@link io.reactivex.rxjava3.core.Scheduler Scheduler} (or its
25 * {@link io.reactivex.rxjava3.core.Scheduler.Worker Scheduler.Worker}) implements this interface and unwrap the
26 * original {@code Runnable} instance. This could help to avoid hooking the same underlying {@code Runnable}
27 * task in a custom {@link RxJavaPlugins#onSchedule(Runnable)} hook set via
28 * the {@link RxJavaPlugins#setScheduleHandler(Function)} method multiple times due to internal delegation
29 * of the default {@code Scheduler.scheduleDirect} or {@code Scheduler.Worker.schedule} methods.
30 * <p>History: 2.1.7 - experimental
31 * @since 2.2
32 */
33 public interface SchedulerRunnableIntrospection {
34
35 /**
36 * Returns the wrapped action.
37 *
38 * @return the wrapped action. Cannot be null.
39 */
40 @NonNull
41 Runnable getWrappedRunnable();
42 }