net.sf.gogui.game

Class GameInfo

java.lang.Object

net.sf.gogui.game.GameInfo

All Implemented Interfaces:

ConstGameInfo

public class GameInfo
extends java.lang.Object
implements ConstGameInfo

Game information. Contains information about handicap, rules and players.

Constructor Summary

Constructors

Constructor and Description
GameInfo()
GameInfo(ConstGameInfo info)

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(ConstGameInfo info)
boolean	equals(java.lang.Object object)
java.lang.String	get(StringInfo type)
java.lang.String	get(StringInfoColor type, GoColor c)
int	getHandicap()
Komi	getKomi() Get komi.
TimeSettings	getTimeSettings()
int	hashCode() Hash code dummy function (don't use).
boolean	isEmpty()
Score.ScoringMethod	parseRules() Try to parse rules.
void	set(StringInfoColor type, GoColor c, java.lang.String value)
void	set(StringInfo type, java.lang.String value)
void	setHandicap(int handicap)
void	setKomi(Komi komi)
void	setTimeSettings(TimeSettings timeSettings) Set time settings.
java.lang.String	suggestGameName() Suggest a game name from the player names.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameInfo

public GameInfo()

GameInfo

public GameInfo(ConstGameInfo info)

Method Detail

copyFrom

public final void copyFrom(ConstGameInfo info)

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

get

public java.lang.String get(StringInfo type)

Specified by:

get in interface ConstGameInfo

get

public java.lang.String get(StringInfoColor type,
                   GoColor c)

Specified by:

get in interface ConstGameInfo

getHandicap

public int getHandicap()

Specified by:

getHandicap in interface ConstGameInfo

getKomi

public Komi getKomi()

Get komi.

Specified by:

getKomi in interface ConstGameInfo

Returns:

The komi or null if komi is unknown.

getTimeSettings

public TimeSettings getTimeSettings()

Specified by:

getTimeSettings in interface ConstGameInfo

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

isEmpty

public boolean isEmpty()

parseRules

public Score.ScoringMethod parseRules()

Try to parse rules.

Specified by:

parseRules in interface ConstGameInfo

Returns:

Score.ScoringMethod.TERRITORY if rules string (to lowercase) is "japanese", Score.ScoringMethod.AREA otherwise.

set

public void set(StringInfo type,
       java.lang.String value)

set

public void set(StringInfoColor type,
       GoColor c,
       java.lang.String value)

setHandicap

public void setHandicap(int handicap)

setKomi

public void setKomi(Komi komi)

setTimeSettings

public void setTimeSettings(TimeSettings timeSettings)

Set time settings.

suggestGameName

public java.lang.String suggestGameName()

Suggest a game name from the player names.

Specified by:

suggestGameName in interface ConstGameInfo

Returns:

A game name built from the player names or null, if not at least one player name is known.