Record Class BlockingScheduler

java.lang.Object
java.lang.Record
io.reactivex.rxjava4.schedulers.BlockingScheduler
Record Components:
backingScheduler - the scheduler instance
public record BlockingScheduler(io.reactivex.rxjava4.internal.schedulers.BlockingCurrentThreadScheduler backingScheduler) extends Record
Holds onto a blocking scheduler instance and provides access to its execute() method and a way to obtain a pure Scheduler instance to be used as parameter.
Since:
4.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    BlockingScheduler(io.reactivex.rxjava4.internal.schedulers.BlockingCurrentThreadScheduler backingScheduler)
    Creates an instance of a BlockingScheduler record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.reactivex.rxjava4.internal.schedulers.BlockingCurrentThreadScheduler
    backingScheduler()
    Returns the value of the backingScheduler record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    void
    execute()
    Begin executing the blocking event loop without any initial action.
    void
    execute(Action action)
    Begin executing the blocking event loop with the given initial action (usually contain the rest of the 'main' method).
    final int
    hashCode()
    Returns a hash code value for this object.
    Scheduler
    scheduler()
    Returns the Scheduler view to submit tasks to or use it as a parameter.
    void
    shutdown()
    Shuts down the underlying blocking current thread scheduler
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BlockingScheduler

      public BlockingScheduler(io.reactivex.rxjava4.internal.schedulers.BlockingCurrentThreadScheduler backingScheduler)
      Creates an instance of a BlockingScheduler record class.
      Parameters:
      backingScheduler - the value for the backingScheduler record component

  • Method Details

    • scheduler

      public Scheduler scheduler()
      Returns the Scheduler view to submit tasks to or use it as a parameter.
      Returns:
      the Scheduler view of the underlying blocking current thread scheduler.

    • execute

      public void execute()
      Begin executing the blocking event loop without any initial action.

      This method will block until the Scheduler.shutdown() is invoked.

      See Also:

    • execute

      public void execute(Action action)
      Begin executing the blocking event loop with the given initial action (usually contain the rest of the 'main' method).

      This method will block until the Scheduler.shutdown() is invoked.

      Parameters:
      action - the action to execute

    • shutdown

      public void shutdown()
      Shuts down the underlying blocking current thread scheduler

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • backingScheduler

      public io.reactivex.rxjava4.internal.schedulers.BlockingCurrentThreadScheduler backingScheduler()
      Returns the value of the backingScheduler record component.
      Returns:
      the value of the backingScheduler record component