Class ShutdownResult

java.lang.Object

com.soklet.ShutdownResult

@ThreadSafe
public final class ShutdownResult
extends Object

Immutable result of one Soklet lifecycle attempt.

A result is complete when every configured lifecycle component has affirmative termination proof and no framework-tracked activity remains. Throwable instances retain their exact identities and may contain application-sensitive data; callers own any logging or disclosure decision.

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<@NonNull ShutdownComponentResult>	getShutdownComponentResult(@NonNull ShutdownComponentType shutdownComponentType)	Looks up terminal evidence for one configured shutdown component type.
@NonNull List<@NonNull ShutdownComponentResult>	getShutdownComponentResults()
@NonNull ShutdownDisposition	getShutdownDisposition()
@NonNull StartupDisposition	getStartupDisposition()
@NonNull Optional<@NonNull Throwable>	getStartupFailureCause()
@NonNull Optional<@NonNull UnexpectedShutdownComponentTermination>	getUnexpectedShutdownComponentTermination()
@NonNull Boolean	isComplete()
@NonNull String	toString()	Returns a bounded, single-line diagnostic with dispositions, component results, failure presence and residual-component counts when available.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getShutdownDisposition

public @NonNull ShutdownDisposition getShutdownDisposition()

Returns:

aggregate shutdown disposition

getStartupDisposition

public @NonNull StartupDisposition getStartupDisposition()

Returns:

startup disposition for the same lifecycle attempt

getShutdownComponentResults

public @NonNull List<@NonNull ShutdownComponentResult> getShutdownComponentResults()

Returns:

immutable shutdown component results in ShutdownComponentType enum order

getShutdownComponentResult

public @NonNull Optional<@NonNull ShutdownComponentResult> getShutdownComponentResult(@NonNull ShutdownComponentType shutdownComponentType)

Looks up terminal evidence for one configured shutdown component type.

Parameters:

shutdownComponentType - shutdown component type

Returns:

shutdown component result, otherwise empty when that type was not configured

Throws:

NullPointerException - if shutdownComponentType is null

getStartupFailureCause

public @NonNull Optional<@NonNull Throwable> getStartupFailureCause()

Returns:

the cause associated with a failed, timed-out, or canceled startup attempt, otherwise empty

getUnexpectedShutdownComponentTermination

public @NonNull Optional<@NonNull UnexpectedShutdownComponentTermination> getUnexpectedShutdownComponentTermination()

Returns:

the first premature shutdown component termination, otherwise empty

isComplete

public @NonNull Boolean isComplete()

Returns:

true exactly when the disposition is not ShutdownDisposition.INCOMPLETE

toString

public @NonNull String toString()

Returns a bounded, single-line diagnostic with dispositions, component results, failure presence and residual-component counts when available. Does not render Throwable instances, residual-summary text or retained runtime objects. Inspect the typed accessors for full evidence.

Overrides:

toString in class Object

Returns:

compact lifecycle diagnostic; not a serialization format