de.java_chess.javaChess.notation
Interface GameNotation

All Known Implementing Classes:
GameNotationImpl

public interface GameNotation

This interface defines the functionality to notate a entire game.


Method Summary
 void addPly(PlyNotation plyNotation)
          Add a new ply with it's notation.
 java.lang.String getMove(int moveIndex, boolean white)
          Get the notation for a given move and piece color.
 java.lang.String getPlayerInfo(boolean white)
          Get some info on a player.
 void setPlayerInfo(java.lang.String playerInfo, boolean white)
          Set the info on a player.
 java.lang.String toString()
          Get the entire game as a string.
 

Method Detail

getMove

public java.lang.String getMove(int moveIndex,
                                boolean white)
Get the notation for a given move and piece color.
Parameters:
moveIndex - The index of the move.
boolean - white Flag to indicate if the color is white.
Returns:
The notation for a given move and color.

addPly

public void addPly(PlyNotation plyNotation)
Add a new ply with it's notation.
Parameters:
plyNotation - The notation of the new ply.

toString

public java.lang.String toString()
Get the entire game as a string.
Overrides:
toString in class java.lang.Object
Returns:
The entire game as a string.

getPlayerInfo

public java.lang.String getPlayerInfo(boolean white)
Get some info on a player.
Returns:
Some info on a player.

setPlayerInfo

public void setPlayerInfo(java.lang.String playerInfo,
                          boolean white)
Set the info on a player.
Parameters:
playerInfo - The player info.
white - Flag to indicate, if it's the player with the white pieces.