Record Class StandardBufferedConfig

java.lang.Object
java.lang.Record
io.reactivex.rxjava4.core.config.StandardBufferedConfig
Record Components:
errorMode - how to handle when errors appear from the inner or outer sources
bufferSize - the expected number of items to buffer or prefetch from the various sources
public record StandardBufferedConfig(@NonNull ErrorMode errorMode, int bufferSize) extends Record
Configuration record for operators which have three error handling modes and a buffer size or prefetch like parameter.
Since:
4.0.0

  • Field Details

    • DEFAULT

      public static final StandardBufferedConfig DEFAULT
      The default configuration with no error delays and bufferSize of Observable.bufferSize().

    • DELAY_ERRORS

      public static final StandardBufferedConfig DELAY_ERRORS
      The default configuration with error delays till the end and bufferSize of Observable.bufferSize().

    • DELAY_ERRORS_BOUNDARY

      public static final StandardBufferedConfig DELAY_ERRORS_BOUNDARY
      The default configuration with error delays till the boundary and bufferSize of Observable.bufferSize().

    • MIN_DEFAULT

      public static final StandardBufferedConfig MIN_DEFAULT
      The default config with no error delay and 2 as the maximum buffer size / prefetch amount setting.

    • MIN_DELAY_ERRORS

      public static final StandardBufferedConfig MIN_DELAY_ERRORS
      The default config with error delay and 2 as the maximum buffer size / prefetch amount setting.

    • MIN_DELAY_ERRORS_BOUNDARY

      public static final StandardBufferedConfig MIN_DELAY_ERRORS_BOUNDARY
      The default config with error delay till the boundary and 2 as the maximum buffer size / prefetch amount setting.

  • Constructor Details

    • StandardBufferedConfig

      public StandardBufferedConfig(@NonNull @NonNull ErrorMode errorMode)
      Sets the error mode to the provided value and the bufferSize to Flowable.bufferSize()
      Parameters:
      errorMode - how to handle when errors appear from the inner or outer sources

    • StandardBufferedConfig

      public StandardBufferedConfig(boolean delayErrors)
      Sets the error mode to IMMEDIATE (false) or END (true) and the bufferSize to Flowable.bufferSize().
      Parameters:
      delayErrors - if true, ErrorMode.END is used, ErrorMode.IMMEDIATE otherwise

    • StandardBufferedConfig

      public StandardBufferedConfig(int bufferSize)
      Sets the error mode to IMMEDIATE and the bufferSize to the provided value.
      Parameters:
      bufferSize - the expected number of outer sources to buffer while processing an inner source

    • StandardBufferedConfig

      public StandardBufferedConfig(boolean delayErrors, int bufferSize)
      Sets the error mode to IMMEDIATE (false) or END (true) and the bufferSize to the provided value.
      Parameters:
      delayErrors - if true, ErrorMode.END is used, ErrorMode.IMMEDIATE otherwise
      bufferSize - the expected number of outer sources to buffer while processing an inner source

    • StandardBufferedConfig

      public StandardBufferedConfig(@NonNull @NonNull ErrorMode errorMode, int bufferSize)
      Sets the error mode and the bufferSize to the provided values.
      Parameters:
      errorMode - how to handle when errors appear from the inner or outer sources
      bufferSize - the expected number of outer sources to buffer while processing an inner source

  • Method Details

    • delayErrors

      public boolean delayErrors()
      Returns true if this config is set to a delayed error handling mode, such as BOUNDARY or END
      Returns:
      true if this config is set to a delayed error handling mode,

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • errorMode

      @NonNull public @NonNull ErrorMode errorMode()
      Returns the value of the errorMode record component.
      Returns:
      the value of the errorMode record component

    • bufferSize

      public int bufferSize()
      Returns the value of the bufferSize record component.
      Returns:
      the value of the bufferSize record component