net.sf.gogui.game

Class TimeSettings

java.lang.Object

net.sf.gogui.game.TimeSettings

public final class TimeSettings
extends java.lang.Object

Time settings. Time settings consist of a base time for the game and an optional overtime (Canadian byoyomi) for overtime periods. Overtime periods also have a number of moves assigned, which need to be played during an overtime period. The base time can be zero. If no overtime periods are used, the whole game must be finished in the base time. This class is immutable.

Constructor Summary

Constructors

Constructor and Description
TimeSettings(long totalTime) Construct with total time for game.
TimeSettings(long preByoyomi, long byoyomi, int byoyomiMoves) Construct with base time and overtime.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
long	getByoyomi() Get time for overtime period.
int	getByoyomiMoves() Get number of moves per overtime period.
long	getPreByoyomi() Get base time for game.
boolean	getUseByoyomi() Check if overtime periods are used.
int	hashCode() Hash code dummy function (don't use).
static TimeSettings	parse(java.lang.String s) Parse time settings from a string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSettings

public TimeSettings(long totalTime)

Construct with total time for game.

Parameters:

totalTime - Total time for game in milliseconds.

TimeSettings

public TimeSettings(long preByoyomi,
            long byoyomi,
            int byoyomiMoves)

Construct with base time and overtime.

Parameters:

preByoyomi - Base time for game in milliseconds.

byoyomi - Time for overtime period in milliseconds.

byoyomiMoves - Number of moves per overtime period.

Method Detail

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

getByoyomi

public long getByoyomi()

Get time for overtime period.

Returns:

Time for overtime period in milliseconds; undefined if there are no overtime periods in this time settings.

getByoyomiMoves

public int getByoyomiMoves()

Get number of moves per overtime period.

Returns:

Number of moves per overtime period; undefined if there are no overtime periods in this time settings.

getPreByoyomi

public long getPreByoyomi()

Get base time for game.

Returns:

Base time for game in milliseconds; this corresponds to the total time for the game, if there are no overtime periods.

getUseByoyomi

public boolean getUseByoyomi()

Check if overtime periods are used.

Returns:

True, if overtime periods are used in this time settings.

hashCode

public int hashCode()

Hash code dummy function (don't use). This class is not desgined to be used in a HashMap/HashTable. The function will trigger an assertion if assertions are enabled.

Overrides:

hashCode in class java.lang.Object

parse

public static TimeSettings parse(java.lang.String s)
                          throws ErrorMessage

Parse time settings from a string. The string is expected to be in the format: basetime[+overtime/moves]
The base time and overtime (byoyomi) can have an optional unit specifier (m or min for minutes; s or sec for seconds; default is minutes).

Parameters:

s - The string.

Returns:

TimeSettings The time settings corresponding to this string.

Throws:

ErrorMessage - On syntax error or invalid values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object