org.springframework.http.server.reactive

Enum AbstractListenerReadPublisher.State

java.lang.Object

java.lang.Enum<AbstractListenerReadPublisher.State>

org.springframework.http.server.reactive.AbstractListenerReadPublisher.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractListenerReadPublisher.State>

Enclosing class:

AbstractListenerReadPublisher<T>

private static enum AbstractListenerReadPublisher.State
extends java.lang.Enum<AbstractListenerReadPublisher.State>

Represents a state for the Publisher to be in. The following figure indicate the four different states that exist, and the relationships between them.

       UNSUBSCRIBED
        |
        v
 NO_DEMAND -------------------> DEMAND
    |    ^                      ^    |
    |    |                      |    |
    |    --------- READING <-----    |
    |                 |              |
    |                 v              |
    ------------> COMPLETED <---------
 

Refer to the individual states for more information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETED The terminal completed state.
DEMAND State that gets entered when there is demand.
NO_DEMAND State that gets entered when there is no demand.
READING
UNSUBSCRIBED The initial unsubscribed state.

Method Summary

Modifier and Type	Method and Description
(package private) <T> void	cancel(AbstractListenerReadPublisher<T> publisher)
(package private) <T> void	onAllDataRead(AbstractListenerReadPublisher<T> publisher)
(package private) <T> void	onDataAvailable(AbstractListenerReadPublisher<T> publisher)
(package private) <T> void	onError(AbstractListenerReadPublisher<T> publisher, java.lang.Throwable t)
(package private) <T> void	request(AbstractListenerReadPublisher<T> publisher, long n)
(package private) <T> void	subscribe(AbstractListenerReadPublisher<T> publisher, <any> subscriber)
static AbstractListenerReadPublisher.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbstractListenerReadPublisher.State[]	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

Enum Constant Detail

UNSUBSCRIBED

public static final AbstractListenerReadPublisher.State UNSUBSCRIBED

The initial unsubscribed state. Will respond to #subscribe(AbstractListenerReadPublisher, Subscriber) by changing state to NO_DEMAND.

NO_DEMAND

public static final AbstractListenerReadPublisher.State NO_DEMAND

State that gets entered when there is no demand. Responds to request(AbstractListenerReadPublisher, long) by increasing the demand, changing state to DEMAND and will check whether there is data available for reading.

DEMAND

public static final AbstractListenerReadPublisher.State DEMAND

State that gets entered when there is demand. Responds to onDataAvailable(AbstractListenerReadPublisher) by reading the available data. The state will be changed to NO_DEMAND if there is no demand.

READING

public static final AbstractListenerReadPublisher.State READING

COMPLETED

public static final AbstractListenerReadPublisher.State COMPLETED

The terminal completed state. Does not respond to any events.

Method Detail

values

public static AbstractListenerReadPublisher.State[] 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 (AbstractListenerReadPublisher.State c : AbstractListenerReadPublisher.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static AbstractListenerReadPublisher.State 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

subscribe

<T> void subscribe(AbstractListenerReadPublisher<T> publisher,
                   <any> subscriber)

request

<T> void request(AbstractListenerReadPublisher<T> publisher,
                 long n)

cancel

<T> void cancel(AbstractListenerReadPublisher<T> publisher)

onDataAvailable

<T> void onDataAvailable(AbstractListenerReadPublisher<T> publisher)

onAllDataRead

<T> void onAllDataRead(AbstractListenerReadPublisher<T> publisher)

onError

<T> void onError(AbstractListenerReadPublisher<T> publisher,
                 java.lang.Throwable t)