Record Class TurnContext.Clock

java.lang.Object

java.lang.Record

lv.id.jc.dicechess.runtime.TurnContext.Clock

Record Components:

remainingMillis - milliseconds left on the mover's own clock

opponentRemainingMillis - milliseconds left on the opponent's clock

incrementMillis - the per-turn Fischer increment in milliseconds, credited after each completed turn, or null when the control has none (a sudden-death or per-move game). Feed it to the engine's time manager as the increment term — a null naturally coalesces to a zero increment

Enclosing class:

TurnContext

public static record TurnContext.Clock(long remainingMillis, long opponentRemainingMillis, Long incrementMillis)
extends Record

The game clock as of this turn. Present only for a timed game — TurnContext.clock() is null when the game is untimed, so a single null check answers "is this game timed?". Both remaining times are always present together (a game has clocks for both sides or neither), so they are primitive; only the increment can be absent.

Constructor Summary

Constructors

Constructor	Description
Clock(long remainingMillis, long opponentRemainingMillis, Long incrementMillis)	Creates an instance of a Clock 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.
Long	incrementMillis()	Returns the value of the incrementMillis record component.
long	opponentRemainingMillis()	Returns the value of the opponentRemainingMillis record component.
long	remainingMillis()	Returns the value of the remainingMillis 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

Clock

public Clock(long remainingMillis,
 long opponentRemainingMillis,
 Long incrementMillis)

Creates an instance of a Clock record class.

Parameters:

remainingMillis - the value for the remainingMillis record component

opponentRemainingMillis - the value for the opponentRemainingMillis record component

incrementMillis - the value for the incrementMillis 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.

remainingMillis

public long remainingMillis()

Returns the value of the remainingMillis record component.

Returns:

the value of the remainingMillis record component

opponentRemainingMillis

public long opponentRemainingMillis()

Returns the value of the opponentRemainingMillis record component.

Returns:

the value of the opponentRemainingMillis record component

incrementMillis

public Long incrementMillis()

Returns the value of the incrementMillis record component.

Returns:

the value of the incrementMillis record component