hu.akarnokd.rxjava2.internal.subscriptions

Enum SubscriptionHelper

java.lang.Object

java.lang.Enum<SubscriptionHelper>

hu.akarnokd.rxjava2.internal.subscriptions.SubscriptionHelper

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubscriptionHelper>

public enum SubscriptionHelper
extends java.lang.Enum<SubscriptionHelper>

Utility methods to validate Subscriptions and Disposables in the various onSubscribe calls.

Method Summary

Modifier and Type	Method and Description
static Consumer<org.reactivestreams.Subscription>	consumeAndCancel() Returns a consumer which calls cancel on the supplied Subscription.
static void	reportDisposableSet() Reports that the disposable is already set to the RxJavaPlugins error handler.
static void	reportSubscriptionSet() Reports that the subscription is already set to the RxJavaPlugins error handler.
static boolean	validateDisposable(Disposable current, Disposable next) Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns true
static boolean	validateRequest(long n) Validates that the n is positive.
static boolean	validateSubscription(org.reactivestreams.Subscription current, org.reactivestreams.Subscription next) Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns true
static SubscriptionHelper	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SubscriptionHelper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static SubscriptionHelper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SubscriptionHelper c : SubscriptionHelper.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubscriptionHelper valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

validateSubscription

public static boolean validateSubscription(org.reactivestreams.Subscription current,
                                           org.reactivestreams.Subscription next)

Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns true

Parameters:

current - the current Subscription, expected to be null

next - the next Subscription, expected to be non-null

Returns:

true if the validation failed

reportSubscriptionSet

public static void reportSubscriptionSet()

Reports that the subscription is already set to the RxJavaPlugins error handler.

validateDisposable

public static boolean validateDisposable(Disposable current,
                                         Disposable next)

Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns true

Parameters:

current - the current Disposable, expected to be null

next - the next Disposable, expected to be non-null

Returns:

true if the validation failed

reportDisposableSet

public static void reportDisposableSet()

Reports that the disposable is already set to the RxJavaPlugins error handler.

validateRequest

public static boolean validateRequest(long n)

Validates that the n is positive.

Parameters:

n - the request amount

Returns:

false if n is non-positive.

consumeAndCancel

public static Consumer<org.reactivestreams.Subscription> consumeAndCancel()

Returns a consumer which calls cancel on the supplied Subscription.

Returns:

a consumer which calls cancel on the supplied Subscription