Class DefaultHealthContributorRegistry

java.lang.Object

org.springframework.boot.health.registry.DefaultHealthContributorRegistry

All Implemented Interfaces:

Iterable<HealthContributors.Entry>, HealthContributors, HealthContributorRegistry

public class DefaultHealthContributorRegistry
extends Object
implements HealthContributorRegistry

Default HealthContributorRegistry implementation.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from interface HealthContributors

HealthContributors.Entry

Constructor Summary

Constructors

Constructor	Description
DefaultHealthContributorRegistry()	Create a new empty DefaultHealthContributorRegistry instance.
DefaultHealthContributorRegistry(@Nullable Collection<? extends HealthContributorNameValidator> nameValidators, @Nullable Consumer<BiConsumer<String, HealthContributor>> initialRegistrations)	Create a new DefaultHealthContributorRegistry instance.

Method Summary

Modifier and Type	Method	Description
@Nullable HealthContributor	getContributor(String name)	Return the contributor with the given name.
void	registerContributor(String name, HealthContributor contributor)	Register a contributor with the given name.
Stream<HealthContributors.Entry>	stream()	Return a stream of the contributor entries.
@Nullable HealthContributor	unregisterContributor(String name)	Unregister a previously registered contributor.

Methods inherited from class Object

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

Methods inherited from interface HealthContributors

iterator

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

DefaultHealthContributorRegistry

public DefaultHealthContributorRegistry()

Create a new empty DefaultHealthContributorRegistry instance.

DefaultHealthContributorRegistry

public DefaultHealthContributorRegistry(@Nullable Collection<? extends HealthContributorNameValidator> nameValidators,
 @Nullable Consumer<BiConsumer<String, HealthContributor>> initialRegistrations)

Create a new DefaultHealthContributorRegistry instance.

Parameters:

nameValidators - the name validators to apply

initialRegistrations - callback to setup any initial registrations

Method Details

getContributor

public @Nullable HealthContributor getContributor(String name)

Description copied from interface: HealthContributors

Return the contributor with the given name.

Specified by:

getContributor in interface HealthContributors

Parameters:

name - the name of the contributor

Returns:

a contributor instance or null

stream

public Stream<HealthContributors.Entry> stream()

Description copied from interface: HealthContributors

Return a stream of the contributor entries.

Specified by:

stream in interface HealthContributors

Returns:

the stream of named contributors

registerContributor

public void registerContributor(String name,
 HealthContributor contributor)

Description copied from interface: HealthContributorRegistry

Register a contributor with the given name.

Specified by:

registerContributor in interface HealthContributorRegistry

Parameters:

name - the name of the contributor

contributor - the contributor to register

unregisterContributor

public @Nullable HealthContributor unregisterContributor(String name)

Description copied from interface: HealthContributorRegistry

Unregister a previously registered contributor.

Specified by:

unregisterContributor in interface HealthContributorRegistry

Parameters:

name - the name of the contributor to unregister

Returns:

the unregistered indicator, or null if no indicator was found in the registry for the given name.