ictk.boardgame.io
Interface MoveNotation

All Known Implementing Classes:

ChessMoveNotation

public interface MoveNotation

An interface for converting between Moves and Strings.

Method Summary

java.lang.String	moveToString(Move m) convert a Move into a String notation
java.lang.String	resultToString(Result result) convert a Result into a String.
Move	stringToMove(Board b, java.lang.String s) convert a String into a Move.
Result	stringToResult(java.lang.String s) convert a String into a Result object

Method Detail

stringToMove

public Move stringToMove(Board b,
                         java.lang.String s)
                  throws AmbiguousMoveException,
                         IllegalMoveException

convert a String into a Move. The Board is necessary because often moves are made in a short-hand that is relative to the board.

Throws:

AmbiguousMoveException

IllegalMoveException

moveToString

public java.lang.String moveToString(Move m)

convert a Move into a String notation

stringToResult

public Result stringToResult(java.lang.String s)

convert a String into a Result object

resultToString

public java.lang.String resultToString(Result result)

convert a Result into a String.