org.springframework.http.server.reactive

Enum AbstractListenerWriteProcessor.State

java.lang.Object

java.lang.Enum<AbstractListenerWriteProcessor.State>

org.springframework.http.server.reactive.AbstractListenerWriteProcessor.State

All Implemented Interfaces:

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

Enclosing class:

AbstractListenerWriteProcessor<T>

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

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

       UNSUBSCRIBED
        |
        v
 REQUESTED -------------------> RECEIVED
         ^                      ^
         |                      |
         --------- WRITING <-----
                      |
                      v
                  COMPLETED
 

Refer to the individual states for more information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETED The terminal completed state.
RECEIVED State that gets entered after a data has been received.
REQUESTED State that gets entered after a data has been requested.
UNSUBSCRIBED The initial unsubscribed state.
WRITING State that gets entered after a writing of the current data has been onWritePossible started.

Method Summary

Modifier and Type	Method and Description
<T> void	onComplete(AbstractListenerWriteProcessor<T> processor)
<T> void	onError(AbstractListenerWriteProcessor<T> processor, java.lang.Throwable ex)
<T> void	onNext(AbstractListenerWriteProcessor<T> processor, T data)
<T> void	onSubscribe(AbstractListenerWriteProcessor<T> processor, Subscription subscription)
<T> void	onWritePossible(AbstractListenerWriteProcessor<T> processor)
static AbstractListenerWriteProcessor.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbstractListenerWriteProcessor.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 AbstractListenerWriteProcessor.State UNSUBSCRIBED

The initial unsubscribed state. Will respond to onSubscribe by requesting 1 data from the subscription, and change state to REQUESTED.

REQUESTED

public static final AbstractListenerWriteProcessor.State REQUESTED

State that gets entered after a data has been requested. Responds to onNext by changing state to RECEIVED, and responds to onComplete by changing state to COMPLETED.

RECEIVED

public static final AbstractListenerWriteProcessor.State RECEIVED

State that gets entered after a data has been received. Responds to onWritePossible by writing the current data and changes the state to WRITING. If it can be written completely, changes the state to either REQUESTED if the subscription has not been completed; or COMPLETED if it has. If it cannot be written completely the state will be changed to #RECEIVED.

WRITING

public static final AbstractListenerWriteProcessor.State WRITING

State that gets entered after a writing of the current data has been onWritePossible started.

COMPLETED

public static final AbstractListenerWriteProcessor.State COMPLETED

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

Method Detail

values

public static AbstractListenerWriteProcessor.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 (AbstractListenerWriteProcessor.State c : AbstractListenerWriteProcessor.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 AbstractListenerWriteProcessor.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

onSubscribe

public <T> void onSubscribe(AbstractListenerWriteProcessor<T> processor,
                            Subscription subscription)

onNext

public <T> void onNext(AbstractListenerWriteProcessor<T> processor,
                       T data)

onError

public <T> void onError(AbstractListenerWriteProcessor<T> processor,
                        java.lang.Throwable ex)

onComplete

public <T> void onComplete(AbstractListenerWriteProcessor<T> processor)

onWritePossible

public <T> void onWritePossible(AbstractListenerWriteProcessor<T> processor)