io.reactivex.rxjava3.annotations

Annotation Type SchedulerSupport

@Retention(value=RUNTIME)
 @Documented
 @Target(value={CONSTRUCTOR,METHOD,TYPE})
public @interface SchedulerSupport

Indicates what kind of scheduler the class or method uses.

Constants are provided for instances from Schedulers as well as values for not using a scheduler and a manually-specified scheduler. Libraries providing their own values should namespace them with their base package name followed by a colon (:) and then a human-readable name (e.g., com.example:ui-thread).

Since:

2.0

Field Summary

Fields

Modifier and Type	Fields and Description
static String	COMPUTATION The operator/class runs on RxJava's computation scheduler or takes timing information from it.
static String	CUSTOM A special value indicating the operator/class requires a scheduler to be manually specified.
static String	IO The operator/class runs on RxJava's I/O scheduler or takes timing information from it.
static String	NEW_THREAD The operator/class runs on RxJava's new thread scheduler or takes timing information from it.
static String	NONE A special value indicating the operator/class doesn't use schedulers.
static String	SINGLE The operator/class runs on RxJava's single scheduler or takes timing information from it.
static String	TRAMPOLINE The operator/class runs on RxJava's trampoline scheduler or takes timing information from it.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The kind of scheduler the class or method uses.

Field Detail

NONE

public static final String NONE

A special value indicating the operator/class doesn't use schedulers.

CUSTOM

public static final String CUSTOM

A special value indicating the operator/class requires a scheduler to be manually specified.

COMPUTATION

public static final String COMPUTATION

The operator/class runs on RxJava's computation scheduler or takes timing information from it.

IO

public static final String IO

The operator/class runs on RxJava's I/O scheduler or takes timing information from it.

NEW_THREAD

public static final String NEW_THREAD

The operator/class runs on RxJava's new thread scheduler or takes timing information from it.

TRAMPOLINE

public static final String TRAMPOLINE

The operator/class runs on RxJava's trampoline scheduler or takes timing information from it.

SINGLE

public static final String SINGLE

The operator/class runs on RxJava's single scheduler or takes timing information from it.

History: 2.0.8 - experimental

Since:

2.2

Element Detail

value

public abstract String value

The kind of scheduler the class or method uses.

Returns:

the name of the scheduler the class or method uses