org.springframework.boot.availability

Class ReadinessStateChangedEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.boot.availability.ReadinessStateChangedEvent

All Implemented Interfaces:

Serializable

public class ReadinessStateChangedEvent
extends ApplicationEvent

ApplicationEvent sent when the ReadinessState of the application changes.

Any application component can send such events to update the state of the application.

Since:

2.3.0

Author:

Brian Clozel

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
ReadinessState	getReadinessState()
static ReadinessStateChangedEvent	ready() Create a new ApplicationEvent signaling that the ReadinessState is ready.
static ReadinessStateChangedEvent	unready() Create a new ApplicationEvent signaling that the ReadinessState is unready.

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Method Detail

getReadinessState

public ReadinessState getReadinessState()

ready

public static ReadinessStateChangedEvent ready()

Create a new ApplicationEvent signaling that the ReadinessState is ready.

Returns:

the application event

unready

public static ReadinessStateChangedEvent unready()

Create a new ApplicationEvent signaling that the ReadinessState is unready.

Returns:

the application event