net.sf.gogui.go

Class Move

java.lang.Object

net.sf.gogui.go.Move

public final class Move
extends java.lang.Object

Move containing a point and a color. The point can be null (for pass move). The color is black or white. This class is immutable, references are unique.

Method Summary

Methods

Modifier and Type	Method and Description
static Move	get(GoColor color, GoPoint point) Factory method for constructing a move.
static Move	get(GoColor color, int x, int y) Factory method for constructing a move.
GoColor	getColor() Get color of move.
static Move	getPass(GoColor c) Factory method for constructing a pass move.
GoPoint	getPoint() Get stone location of move.
java.lang.String	toString() Get string representation of move.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Move get(GoColor color,
       int x,
       int y)

Factory method for constructing a move.

Parameters:

color - The color of the move

x - Column in [0..GoPoint.MAX_SIZE - 1]

y - Row in [0..GoPoint.MAX_SIZE - 1]

Returns:

Reference to this move

get

public static Move get(GoColor color,
       GoPoint point)

Factory method for constructing a move.

Parameters:

color - The color of the move (empty can still be used for removing a stone on the board, but this will be deprecated in the future)

point - Location of the move (null for pass move)

Returns:

Reference to this move

getPass

public static Move getPass(GoColor c)

Factory method for constructing a pass move.

Parameters:

c - The color of the move.

Returns:

Reference to this move

getColor

public GoColor getColor()

Get color of move.

Returns:

Color of move

getPoint

public GoPoint getPoint()

Get stone location of move.

Returns:

Location of move; null for pass move

toString

public java.lang.String toString()

Get string representation of move.

Overrides:

toString in class java.lang.Object

Returns:

String representation using an uppercase letter for the color and an uppercase string for the point (e.g. B C3, W PASS). This representation is also guaranteed to be compatible with the formats used in the Go Text Protocol.