Interface ReactiveHealthContributors

All Superinterfaces:

Iterable<ReactiveHealthContributors.Entry>

All Known Subinterfaces:

CompositeReactiveHealthContributor, ReactiveHealthContributorRegistry

All Known Implementing Classes:

DefaultReactiveHealthContributorRegistry

public interface ReactiveHealthContributors
extends Iterable<ReactiveHealthContributors.Entry>

A collection of named reactive health contributors.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ReactiveHealthContributors.Entry	A reactive health contributor entry.

Method Summary

Modifier and Type	Method	Description
static @Nullable ReactiveHealthContributors	adapt(@Nullable HealthContributors contributors)	Adapts the given HealthContributors into a ReactiveHealthContributors by scheduling blocking calls to Schedulers.boundedElastic().
default HealthContributors	asHealthContributors()	Return these reactive contributors as standard blocking HealthContributors.
@Nullable ReactiveHealthContributor	getContributor(String name)	Return the contributor with the given name.
default Iterator<ReactiveHealthContributors.Entry>	iterator()
static ReactiveHealthContributors	of(ReactiveHealthContributors... contributors)	Factory method to create a new ReactiveHealthContributors instance composed of the given contributors.
Stream<ReactiveHealthContributors.Entry>	stream()	Return a stream of the contributor entries.

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getContributor

@Nullable ReactiveHealthContributor getContributor(String name)

Return the contributor with the given name.

Parameters:

name - the name of the contributor

Returns:

a contributor instance or null

iterator

default Iterator<ReactiveHealthContributors.Entry> iterator()

Specified by:

iterator in interface Iterable<ReactiveHealthContributors.Entry>

stream

Stream<ReactiveHealthContributors.Entry> stream()

Return a stream of the contributor entries.

Returns:

the stream of named contributors

asHealthContributors

default HealthContributors asHealthContributors()

Return these reactive contributors as standard blocking HealthContributors.

Returns:

blocking health contributors

of

static ReactiveHealthContributors of(ReactiveHealthContributors... contributors)

Factory method to create a new ReactiveHealthContributors instance composed of the given contributors.

Parameters:

contributors - the source contributors in the order they should be combined

Returns:

a new ReactiveHealthContributors instance

adapt

@Contract("!null -> !null")
static @Nullable ReactiveHealthContributors adapt(@Nullable HealthContributors contributors)

Adapts the given HealthContributors into a ReactiveHealthContributors by scheduling blocking calls to Schedulers.boundedElastic().

Parameters:

contributors - the contributors to adapt or null

Returns:

the adapted contributor

See Also:

• ReactiveHealthContributor.adapt(HealthContributor)