io.micronaut.core.async.publisher

Class Publishers

java.lang.Object

io.micronaut.core.async.publisher.Publishers

@Internal
public class Publishers
extends Object

Utilities for working with raw Publisher instances. Designed for internal use by Micronaut and not as a replacement for a reactive library such as RxJava, Reactor, Akka etc.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
Publishers()

Method Summary

Modifier and Type	Method and Description
static <T> T	convertPublisher(Object object, Class<T> publisherType) Attempts to convert the publisher to the given type.
static <T> Publisher<T>	fromCompletableFuture(CompletableFuture<T> future) Build a Publisher from a CompletableFuture.
static <T> Publisher<T>	fromCompletableFuture(Supplier<CompletableFuture<T>> futureSupplier) Build a Publisher from a CompletableFuture.
static List<Class<?>>	getKnownReactiveTypes()
static boolean	isConvertibleToPublisher(Class<?> type) Is the given type a Publisher or convertible to a publisher.
static boolean	isConvertibleToPublisher(Object object) Is the given object a Publisher or convertible to a publisher.
static boolean	isSingle(Class<?> type) Does the given reactive type emit a single result.
static <T> Publisher<T>	just(T value) A Publisher that emits a fixed single value.
static <T> Publisher<T>	just(Throwable error) A Publisher that emits a fixed single value.
static <T,R> Publisher<R>	map(Publisher<T> publisher, Function<T,R> mapper) Map the result from a publisher using the given mapper.
static <T> Publisher<T>	onComplete(Publisher<T> publisher, Supplier<CompletableFuture<Void>> future) Allow executing logic on completion of a Publisher.
static <T> Publisher<T>	then(Publisher<T> publisher, Consumer<T> consumer) Map the result from a publisher using the given mapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

Publishers

public Publishers()

Method Detail

getKnownReactiveTypes

public static List<Class<?>> getKnownReactiveTypes()

Returns:

A list of known reactive types.

fromCompletableFuture

public static <T> Publisher<T> fromCompletableFuture(Supplier<CompletableFuture<T>> futureSupplier)

Build a Publisher from a CompletableFuture.

Type Parameters:

T - The type of the publisher

Parameters:

futureSupplier - The supplier of the CompletableFuture

Returns:

The Publisher

fromCompletableFuture

public static <T> Publisher<T> fromCompletableFuture(CompletableFuture<T> future)

Build a Publisher from a CompletableFuture.

Type Parameters:

T - The type of the publisher

Parameters:

future - The CompletableFuture

Returns:

The Publisher

just

public static <T> Publisher<T> just(T value)

A Publisher that emits a fixed single value.

Type Parameters:

T - The value type

Parameters:

value - The value to emit

Returns:

The Publisher

just

public static <T> Publisher<T> just(Throwable error)

A Publisher that emits a fixed single value.

Type Parameters:

T - The value type

Parameters:

error - The error to emit

Returns:

The Publisher

map

public static <T,R> Publisher<R> map(Publisher<T> publisher,
                                     Function<T,R> mapper)

Map the result from a publisher using the given mapper.

Type Parameters:

T - The generic type

R - The result type

Parameters:

publisher - The publisher

mapper - The mapper

Returns:

The mapped publisher

then

public static <T> Publisher<T> then(Publisher<T> publisher,
                                    Consumer<T> consumer)

Map the result from a publisher using the given mapper.

Type Parameters:

T - The generic type

Parameters:

publisher - The publisher

consumer - The mapper

Returns:

The mapped publisher

onComplete

public static <T> Publisher<T> onComplete(Publisher<T> publisher,
                                          Supplier<CompletableFuture<Void>> future)

Allow executing logic on completion of a Publisher.

Type Parameters:

T - The generic type

Parameters:

publisher - The publisher

future - The runnable

Returns:

The mapped publisher

isConvertibleToPublisher

public static boolean isConvertibleToPublisher(Class<?> type)

Is the given type a Publisher or convertible to a publisher.

Parameters:

type - The type to check

Returns:

True if it is

isConvertibleToPublisher

public static boolean isConvertibleToPublisher(Object object)

Is the given object a Publisher or convertible to a publisher.

Parameters:

object - The object

Returns:

True if it is

convertPublisher

public static <T> T convertPublisher(Object object,
                                     Class<T> publisherType)

Attempts to convert the publisher to the given type.

Type Parameters:

T - The generic type

Parameters:

object - The object to convert

publisherType - The publisher type

Returns:

The Resulting in publisher

isSingle

public static boolean isSingle(Class<?> type)

Does the given reactive type emit a single result.

Parameters:

type - The type

Returns:

True it does