Record Class OperationProgress

java.lang.Object

java.lang.Record

dev.despical.mazeengine.api.operation.OperationProgress

Record Components:

state - the sampled lifecycle state

stage - the diagnostic internal stage text

percent - the estimated progress in 0..100

public record OperationProgress(OperationProgress.State state, String stage, int percent)
extends Record

Captures a point-in-time progress sample for one operation handle.

State is the stable lifecycle contract. Stage is diagnostic text describing an internal step, such as planning or block writing, and should not be parsed as a fixed enum. Query the handle again to obtain a later sample.

Percentage is an estimate for the current operation stage rather than elapsed time. A successful terminal sample reports 100; failed and cancelled samples report zero. Keep using state to decide whether an operation has ended.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OperationProgress.State	Describes whether an operation is active or has reached a final outcome.

Constructor Summary

Constructors

Constructor	Description
OperationProgress(OperationProgress.State state, String stage, int percent)	Creates an instance of a OperationProgress record class.

Method Summary

Modifier and Type	Method	Description
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.
int	percent()	Returns the value of the percent record component.
String	stage()	Returns the value of the stage record component.
OperationProgress.State	state()	Returns the value of the state record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

OperationProgress

public OperationProgress(OperationProgress.State state,
 String stage,
 int percent)

Creates an instance of a OperationProgress record class.

Parameters:

state - the value for the state record component

stage - the value for the stage record component

percent - the value for the percent record component

Method Details

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.

state

public OperationProgress.State state()

Returns the value of the state record component.

Returns:

the value of the state record component

stage

public String stage()

Returns the value of the stage record component.

Returns:

the value of the stage record component

percent

public int percent()

Returns the value of the percent record component.

Returns:

the value of the percent record component