Annotation Type SchedulerSupport


  • @Retention(RUNTIME)
    @Documented
    @Target({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 Description
      static java.lang.String COMPUTATION
      The operator/class runs on RxJava's computation scheduler or takes timing information from it.
      static java.lang.String CUSTOM
      A special value indicating the operator/class requires a scheduler to be manually specified.
      static java.lang.String IO
      The operator/class runs on RxJava's I/O scheduler or takes timing information from it.
      static java.lang.String NEW_THREAD
      The operator/class runs on RxJava's new thread scheduler or takes timing information from it.
      static java.lang.String NONE
      A special value indicating the operator/class doesn't use schedulers.
      static java.lang.String SINGLE
      The operator/class runs on RxJava's single scheduler or takes timing information from it.
      static java.lang.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 Description
      java.lang.String value
      The kind of scheduler the class or method uses.
    • Field Detail

      • NONE

        static final java.lang.String NONE
        A special value indicating the operator/class doesn't use schedulers.
      • CUSTOM

        static final java.lang.String CUSTOM
        A special value indicating the operator/class requires a scheduler to be manually specified.
      • COMPUTATION

        static final java.lang.String COMPUTATION
        The operator/class runs on RxJava's computation scheduler or takes timing information from it.
      • IO

        static final java.lang.String IO
        The operator/class runs on RxJava's I/O scheduler or takes timing information from it.
      • NEW_THREAD

        static final java.lang.String NEW_THREAD
        The operator/class runs on RxJava's new thread scheduler or takes timing information from it.
      • TRAMPOLINE

        static final java.lang.String TRAMPOLINE
        The operator/class runs on RxJava's trampoline scheduler or takes timing information from it.
      • SINGLE

        static final java.lang.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

        java.lang.String value
        The kind of scheduler the class or method uses.
        Returns:
        the name of the scheduler the class or method uses