Record Class MigrationProgress

java.lang.Object

java.lang.Record

com.loomcache.server.sharding.MigrationProgress

Record Components:

totalMoves - the total number of partition moves in the plan

completedMoves - the number of moves completed so far

status - the current migration status

public record MigrationProgress(int totalMoves, int completedMoves, MigrationProgress.MigrationStatus status)
extends Record

Tracks the progress of an ongoing partition rebalance migration.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MigrationProgress.MigrationStatus	The lifecycle states of a partition migration.

Constructor Summary

Constructors

Constructor	Description
MigrationProgress(int totalMoves, int completedMoves, MigrationProgress.MigrationStatus status)	Compact constructor with validation.

Method Summary

Modifier and Type	Method	Description
int	completedMoves()	Returns the value of the completedMoves 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.
static MigrationProgress	idle()	Returns an idle progress instance (no migration in progress).
double	percentComplete()	Returns the percentage of migration completed.
MigrationProgress.MigrationStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
int	totalMoves()	Returns the value of the totalMoves record component.

Methods inherited from class Object

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

Constructor Details

MigrationProgress

public MigrationProgress(int totalMoves,
 int completedMoves,
 MigrationProgress.MigrationStatus status)

Compact constructor with validation.

Method Details

percentComplete

public double percentComplete()

Returns the percentage of migration completed.

Returns:

a value in [0.0, 100.0]

idle

public static MigrationProgress idle()

Returns an idle progress instance (no migration in progress).

Returns:

idle progress (never null)

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.

totalMoves

public int totalMoves()

Returns the value of the totalMoves record component.

Returns:

the value of the totalMoves record component

completedMoves

public int completedMoves()

Returns the value of the completedMoves record component.

Returns:

the value of the completedMoves record component

status

public MigrationProgress.MigrationStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component