Record Class GracefulShutdownCoordinator.ShutdownProgress

java.lang.Object

java.lang.Record

com.loomcache.server.lifecycle.GracefulShutdownCoordinator.ShutdownProgress

Record Components:

phase - the current shutdown phase

completedSteps - the number of steps completed in the current phase

totalSteps - the total number of steps in the current phase

elapsed - the duration elapsed since shutdown started

Enclosing class:

GracefulShutdownCoordinator

public static record GracefulShutdownCoordinator.ShutdownProgress(GracefulShutdownCoordinator.ShutdownPhase phase, int completedSteps, int totalSteps, Duration elapsed)
extends Record

Record representing the current progress of shutdown.

Constructor Summary

Constructors

Constructor	Description
ShutdownProgress(GracefulShutdownCoordinator.ShutdownPhase phase, int completedSteps, int totalSteps, Duration elapsed)	Creates an instance of a ShutdownProgress record class.

Method Summary

Modifier and Type	Method	Description
int	completedSteps()	Returns the value of the completedSteps record component.
Duration	elapsed()	Returns the value of the elapsed record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
GracefulShutdownCoordinator.ShutdownPhase	phase()	Returns the value of the phase record component.
int	progressPercent()	Returns the progress as a percentage (0-100).
final String	toString()	Returns a string representation of this record class.
int	totalSteps()	Returns the value of the totalSteps record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ShutdownProgress

public ShutdownProgress(GracefulShutdownCoordinator.ShutdownPhase phase,
 int completedSteps,
 int totalSteps,
 Duration elapsed)

Creates an instance of a ShutdownProgress record class.

Parameters:

phase - the value for the phase record component

completedSteps - the value for the completedSteps record component

totalSteps - the value for the totalSteps record component

elapsed - the value for the elapsed record component

Method Details

progressPercent

public int progressPercent()

Returns the progress as a percentage (0-100).

Returns:

progress percentage

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

phase

public GracefulShutdownCoordinator.ShutdownPhase phase()

Returns the value of the phase record component.

Returns:

the value of the phase record component

completedSteps

public int completedSteps()

Returns the value of the completedSteps record component.

Returns:

the value of the completedSteps record component

totalSteps

public int totalSteps()

Returns the value of the totalSteps record component.

Returns:

the value of the totalSteps record component

elapsed

public Duration elapsed()

Returns the value of the elapsed record component.

Returns:

the value of the elapsed record component