From f63e049bcbf5f0d2d91a5329eb8b36af6875c91a Mon Sep 17 00:00:00 2001
From: Chris Cochrane <78791827+chriscochrane@users.noreply.github.com>
Date: Wed, 22 Feb 2023 18:04:22 +0000
Subject: [PATCH] ENT-8924 Corrected JavaDoc/KDoc comments for
 ServiceLifecycleEvent (#7294)

---
 .../core/node/services/ServiceLifecycleObserver.kt  | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/core/src/main/kotlin/net/corda/core/node/services/ServiceLifecycleObserver.kt b/core/src/main/kotlin/net/corda/core/node/services/ServiceLifecycleObserver.kt
index ea4302ab22..22a296931b 100644
--- a/core/src/main/kotlin/net/corda/core/node/services/ServiceLifecycleObserver.kt
+++ b/core/src/main/kotlin/net/corda/core/node/services/ServiceLifecycleObserver.kt
@@ -17,6 +17,18 @@ interface ServiceLifecycleObserver {
 }
 
 enum class ServiceLifecycleEvent {
+
+    /**
+     * This event is dispatched when the node is about to start the State Machine. The State Machine will not be started until
+     * all handlers return from processing this event.
+     * Handlers can delay the node start-up, and the processing of flows, by not returning from handling this event until their
+     * CorDapp is ready for flows to be started/resumed.
+     *
+     * If a handler for this event throws [CordaServiceCriticalFailureException] - this is the way to flag that it will not make
+     * sense for Corda node to continue its operation. The lifecycle events dispatcher will endeavor to terminate node's JVM as soon
+     * as practically possible.
+     */
+    BEFORE_STATE_MACHINE_START,
     /**
      * This event is dispatched when State Machine is fully started such that [net.corda.core.node.AppServiceHub] available
      * for [CordaService] to be use.
@@ -25,7 +37,6 @@ enum class ServiceLifecycleEvent {
      * sense for Corda node to continue its operation. The lifecycle events dispatcher will endeavor to terminate node's JVM as soon
      * as practically possible.
      */
-    BEFORE_STATE_MACHINE_START,
     STATE_MACHINE_STARTED,
 }