org.springframework.core

Class ReactiveTypeDescriptor

java.lang.Object

org.springframework.core.ReactiveTypeDescriptor

public final class ReactiveTypeDescriptor
extends Object

Describes the semantics of a reactive type including boolean checks for isMultiValue(), isNoValue(), and supportsEmpty().

Since:

5.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Object	getEmptyValue() Return an empty-value instance for the underlying reactive or async type.
Class<?>	getReactiveType() Return the reactive type for this descriptor.
int	hashCode()
boolean	isDeferred() Whether the underlying operation is deferred and needs to be started explicitly, e.g.
boolean	isMultiValue() Return true if the reactive type can produce more than 1 value can be produced and is therefore a good fit to adapt to Flux.
boolean	isNoValue() Return true if the reactive type does not produce any values and only provides completion and error signals.
static ReactiveTypeDescriptor	multiValue(Class<?> type, Supplier<?> emptySupplier) Descriptor for a reactive type that can produce 0..N values.
static ReactiveTypeDescriptor	nonDeferredAsyncValue(Class<?> type, Supplier<?> emptySupplier) The same as singleOptionalValue(Class, Supplier) but for a non-deferred, async type such as CompletableFuture.
static ReactiveTypeDescriptor	noValue(Class<?> type, Supplier<?> emptySupplier) Descriptor for a reactive type that does not produce any values.
static ReactiveTypeDescriptor	singleOptionalValue(Class<?> type, Supplier<?> emptySupplier) Descriptor for a reactive type that can produce 0..1 values.
static ReactiveTypeDescriptor	singleRequiredValue(Class<?> type) Descriptor for a reactive type that must produce 1 value to complete.
boolean	supportsEmpty() Return true if the reactive type can complete with no values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getReactiveType

public Class<?> getReactiveType()

Return the reactive type for this descriptor.

isMultiValue

public boolean isMultiValue()

Return true if the reactive type can produce more than 1 value can be produced and is therefore a good fit to adapt to Flux. A false return value implies the reactive type can produce 1 value at most and is therefore a good fit to adapt to Mono.

isNoValue

public boolean isNoValue()

Return true if the reactive type does not produce any values and only provides completion and error signals.

supportsEmpty

public boolean supportsEmpty()

Return true if the reactive type can complete with no values.

getEmptyValue

public Object getEmptyValue()

Return an empty-value instance for the underlying reactive or async type. Use of this type implies supportsEmpty() is true.

isDeferred

public boolean isDeferred()

Whether the underlying operation is deferred and needs to be started explicitly, e.g. via subscribing (or similar), or whether it is triggered without the consumer having any control.

Since:

5.2.7

equals

public boolean equals(@Nullable
                      Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

multiValue

public static ReactiveTypeDescriptor multiValue(Class<?> type,
                                                Supplier<?> emptySupplier)

Descriptor for a reactive type that can produce 0..N values.

Parameters:

type - the reactive type

emptySupplier - a supplier of an empty-value instance of the reactive type

singleOptionalValue

public static ReactiveTypeDescriptor singleOptionalValue(Class<?> type,
                                                         Supplier<?> emptySupplier)

Descriptor for a reactive type that can produce 0..1 values.

Parameters:

type - the reactive type

emptySupplier - a supplier of an empty-value instance of the reactive type

singleRequiredValue

public static ReactiveTypeDescriptor singleRequiredValue(Class<?> type)

Descriptor for a reactive type that must produce 1 value to complete.

Parameters:

type - the reactive type

noValue

public static ReactiveTypeDescriptor noValue(Class<?> type,
                                             Supplier<?> emptySupplier)

Descriptor for a reactive type that does not produce any values.

Parameters:

type - the reactive type

emptySupplier - a supplier of an empty-value instance of the reactive type

nonDeferredAsyncValue

public static ReactiveTypeDescriptor nonDeferredAsyncValue(Class<?> type,
                                                           Supplier<?> emptySupplier)

The same as singleOptionalValue(Class, Supplier) but for a non-deferred, async type such as CompletableFuture.

Parameters:

type - the reactive type

emptySupplier - a supplier of an empty-value instance of the reactive type

Since:

5.2.7