Package ke.ric.renderer.api

Record Class RenderProgress

java.lang.Object

java.lang.Record

ke.ric.renderer.api.RenderProgress

Record Components:

phase - current actual-work phase

basisPoints - monotonic progress in 0..10000 (100 basis points equal one percent)

public record RenderProgress(RenderProgress.Phase phase, int basisPoints)
extends Record

Immutable, non-estimated progress for an asynchronous render task. Basis points are monotonic from 0 through 10_000; failed or cancelled tasks keep their last published snapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RenderProgress.Phase	Ordered provider work phases exposed without implementation-specific timing estimates.

Constructor Summary

Constructors

Constructor	Description
RenderProgress(RenderProgress.Phase phase, int basisPoints)	Creates an instance of a RenderProgress record class.

Method Summary

Modifier and Type	Method	Description
int	basisPoints()	Returns the value of the basisPoints 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.
RenderProgress.Phase	phase()	Returns the value of the phase record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

RenderProgress

public RenderProgress(RenderProgress.Phase phase,
 int basisPoints)

Creates an instance of a RenderProgress record class.

Parameters:

phase - the value for the phase record component

basisPoints - the value for the basisPoints 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 '=='.

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 RenderProgress.Phase phase()

Returns the value of the phase record component.

Returns:

the value of the phase record component

basisPoints

public int basisPoints()

Returns the value of the basisPoints record component.

Returns:

the value of the basisPoints record component