hu.akarnokd.rxjava2.internal.util

Enum BackpressureHelper

java.lang.Object

java.lang.Enum<BackpressureHelper>

hu.akarnokd.rxjava2.internal.util.BackpressureHelper

All Implemented Interfaces:

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

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

Utility class to help with backpressure-related operations such as request aggregation.

Method Summary

Modifier and Type	Method and Description
static <T> long	add(java.util.concurrent.atomic.AtomicLongFieldUpdater<T> updater, T instance, long n) Atomically adds the positive value n to the value in the instance through the field updater and caps the result at Long.MAX_VALUE and returns the previous value.
static long	add(java.util.concurrent.atomic.AtomicLong requested, long n) Atomically adds the positive value n to the requested value in the AtomicLong and caps the result at Long.MAX_VALUE and returns the previous value.
static long	addCap(long a, long b) Adds two long values and caps the sum at Long.MAX_VALUE.
static long	multiplyCap(long a, long b) Multiplies two long values and caps the product at Long.MAX_VALUE.
static BackpressureHelper	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BackpressureHelper[]	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 BackpressureHelper[] 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 (BackpressureHelper c : BackpressureHelper.values())
    System.out.println(c);

Returns:

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

valueOf

public static BackpressureHelper 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

addCap

public static long addCap(long a,
                          long b)

Adds two long values and caps the sum at Long.MAX_VALUE.

Parameters:

a - the first value

b - the second value

Returns:

the sum capped at Long.MAX_VALUE

multiplyCap

public static long multiplyCap(long a,
                               long b)

Multiplies two long values and caps the product at Long.MAX_VALUE.

Parameters:

a - the first value

b - the second value

Returns:

the product capped at Long.MAX_VALUE

add

public static long add(java.util.concurrent.atomic.AtomicLong requested,
                       long n)

Atomically adds the positive value n to the requested value in the AtomicLong and caps the result at Long.MAX_VALUE and returns the previous value.

Parameters:

requested - the AtomicLong holding the current requested value

n - the value to add, must be positive (not verified)

Returns:

the original value before the add

add

public static <T> long add(java.util.concurrent.atomic.AtomicLongFieldUpdater<T> updater,
                           T instance,
                           long n)

Atomically adds the positive value n to the value in the instance through the field updater and caps the result at Long.MAX_VALUE and returns the previous value.

Type Parameters:

T - the instance type

Parameters:

updater - the field updater for the requested value

instance - the instance holding the requested value

n - the value to add, must be positive (not verified)

Returns:

the original value before the add