net.sf.gogui.game

Class Clock

java.lang.Object

net.sf.gogui.game.Clock

All Implemented Interfaces:

ConstClock

public final class Clock
extends java.lang.Object
implements ConstClock

Time control for a Go game. If the clock is not initialized with Clock.setTimeSettings, the clock will count upwards, otherwise the time settings with main and/or byoyomi time are used. The time unit is milliseconds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Clock.Listener Listener to clock changes.
static class	Clock.SystemTimeSource Time source using the system time.
static interface	Clock.TimeSource Provides the time for a clock.

Constructor Summary

Constructors

Constructor and Description
Clock()
Clock(Clock.TimeSource timeSource)

Method Summary

Methods

Modifier and Type	Method and Description
int	getMovesLeft(GoColor color) Get moves left.
long	getTimeLeft(GoColor color) Get time left.
TimeSettings	getTimeSettings()
static java.lang.String	getTimeString(double timeLeft, int movesLeft) Format time left to a string.
java.lang.String	getTimeString(GoColor color)
GoColor	getToMove() Return color the clock is currently measuring the time for.
boolean	getUseByoyomi()
void	halt()
boolean	isInByoyomi(GoColor color)
boolean	isInitialized()
boolean	isRunning()
boolean	lostOnTime(GoColor color)
static long	parseTimeString(java.lang.String s) Parses a time string.
void	reset()
void	reset(GoColor color)
void	resume() Resume clock, if it was halted during a player's move time.
void	setListener(Clock.Listener listener) Register listener for clock changes.
void	setTimeLeft(GoColor color, long time, int movesLeft) Set time left.
void	setTimeSettings(TimeSettings settings) Set time settings.
void	startMove(GoColor color) Start time for a move.
void	stopMove() Stop time for a move.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Clock

public Clock()

Clock

public Clock(Clock.TimeSource timeSource)

Method Detail

getMovesLeft

public int getMovesLeft(GoColor color)

Get moves left. Requires: getUseByoyomi() and isInByoyomi(color)

Specified by:

getMovesLeft in interface ConstClock

getTimeLeft

public long getTimeLeft(GoColor color)

Get time left. Requires: isInitialized()

Specified by:

getTimeLeft in interface ConstClock

getTimeSettings

public TimeSettings getTimeSettings()

Specified by:

getTimeSettings in interface ConstClock

getTimeString

public java.lang.String getTimeString(GoColor color)

Specified by:

getTimeString in interface ConstClock

getTimeString

public static java.lang.String getTimeString(double timeLeft,
                             int movesLeft)

Format time left to a string. If movesLeft < 0, only the time will be returned, otherwise after the time string, a slash and the number of moves left will be appended.

getToMove

public GoColor getToMove()

Return color the clock is currently measuring the time for. Returns null, if clock is between a #stopMove and #startMove.

Specified by:

getToMove in interface ConstClock

getUseByoyomi

public boolean getUseByoyomi()

Specified by:

getUseByoyomi in interface ConstClock

halt

public void halt()

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface ConstClock

isInByoyomi

public boolean isInByoyomi(GoColor color)

Specified by:

isInByoyomi in interface ConstClock

isRunning

public boolean isRunning()

Specified by:

isRunning in interface ConstClock

lostOnTime

public boolean lostOnTime(GoColor color)

Specified by:

lostOnTime in interface ConstClock

parseTimeString

public static long parseTimeString(java.lang.String s)

Parses a time string. The expected format is [[H:]MM:]SS.

Returns:

The time in milliseconds or -1, if the time string is not valid.

reset

public void reset()

reset

public void reset(GoColor color)

resume

public void resume()

Resume clock, if it was halted during a player's move time.

setListener

public void setListener(Clock.Listener listener)

Register listener for clock changes. Only one listener supported at the moment. If the clock has a listener, the clock should be stopped with halt() if it is no longer used, otherwise the timer thread can keep an application from terminating.

setTimeSettings

public void setTimeSettings(TimeSettings settings)

Set time settings. Changing the time settings does not change the current state of the clock. The time settings are only used when the clock is reset or the next byoyomi period is initialized.

setTimeLeft

public void setTimeLeft(GoColor color,
               long time,
               int movesLeft)

Set time left.

Parameters:

color - Color to set the time for.

time - New value for time left.

movesLeft - -1, if not in byoyomi.

startMove

public void startMove(GoColor color)

Start time for a move. If the clock was already running, the passed time for the current move is discarded.

stopMove

public void stopMove()

Stop time for a move. If the clock was running, the time for the move is added to the total time for the color the clock was running for; otherwise this function does nothing.