Interface HealthContributors

All Superinterfaces:

Iterable<HealthContributors.Entry>

All Known Subinterfaces:

CompositeHealthContributor, HealthContributorRegistry

All Known Implementing Classes:

DefaultHealthContributorRegistry

public interface HealthContributors
extends Iterable<HealthContributors.Entry>

A collection of named health contributors.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
@Nullable HealthContributor	getContributor(String name)	Return the contributor with the given name.
default Iterator<HealthContributors.Entry>	iterator()
static HealthContributors	of(HealthContributors... contributors)	Factory method to create a new HealthContributors instance composed of the given contributors.
Stream<HealthContributors.Entry>	stream()	Return a stream of the contributor entries.

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getContributor

@Nullable HealthContributor 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<HealthContributors.Entry> iterator()

Specified by:

iterator in interface Iterable<HealthContributors.Entry>

stream

Stream<HealthContributors.Entry> stream()

Return a stream of the contributor entries.

Returns:

the stream of named contributors

of

static HealthContributors of(HealthContributors... contributors)

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

Parameters:

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

Returns:

a new HealthContributors instance