de.java_chess.javaChess.notation
Interface PlyNotation

All Known Implementing Classes:
PlyNotationImpl

public interface PlyNotation

This interface defines the functionality to notate a ply.


Method Summary
 Piece getPiece()
          Get the piece of this ply.
 java.lang.String getPieceTypeNotation(byte pieceType)
          Get the notation for a piece type.
 Ply getPly()
          Get the ply of this notation.
 boolean isCapture()
          Check if the piece captures another piece with this ply.
 void setCapture(boolean capture)
          Set the flag to indicate if another piece is captured with this ply.
 void setPiece(Piece piece)
          Set the piece, that is moved with this ply.
 void setPly(Ply ply)
          Set the ply for this notation.
 java.lang.String toString()
          Render this ply as a string.
 

Method Detail

toString

public java.lang.String toString()
Render this ply as a string.
Overrides:
toString in class java.lang.Object
Returns:
The notated ply as a string.

getPiece

public Piece getPiece()
Get the piece of this ply.
Returns:
The piece, that is moved with this ply.

setPiece

public void setPiece(Piece piece)
Set the piece, that is moved with this ply.
Parameters:
ply - The moved ply.

getPly

public Ply getPly()
Get the ply of this notation.
Returns:
The ply for this notation.

setPly

public void setPly(Ply ply)
Set the ply for this notation.
Parameters:
ply - The ply for this notation.

isCapture

public boolean isCapture()
Check if the piece captures another piece with this ply.
Returns:
true, if another piece is captureed with this ply.

setCapture

public void setCapture(boolean capture)
Set the flag to indicate if another piece is captured with this ply.
Parameters:
capture - Flag to indicate, if this ply captures another piece.

getPieceTypeNotation

public java.lang.String getPieceTypeNotation(byte pieceType)
Get the notation for a piece type.
Parameters:
pieceType - The piece type.
Returns:
The notation for a piece type.