Internet Chess ToolKit
v0.2.0

ictk.boardgame.io
Class GameWriter

java.lang.Object
  extended byjava.io.Writer
      extended byjava.io.PrintWriter
          extended byictk.boardgame.io.GameWriter
Direct Known Subclasses:
ChessWriter

public abstract class GameWriter
extends java.io.PrintWriter

ChessWriter is an abstract class that writer game files


Constructor Summary
GameWriter(java.io.OutputStream _out)
           
GameWriter(java.io.Writer _out)
           
 
Method Summary
abstract  MoveNotation getMoveNotation()
          returns the currect move notation style.
abstract  boolean isExportComments()
          will comments be presented in the output.
abstract  boolean isExportVariations()
          is variation data presented in the Writer's output or not.
abstract  void setExportComments(boolean t)
          are comments presented in the Writer's output or not.
abstract  void setExportVariations(boolean t)
          should variations be presented in the Writer's output or not.
abstract  void setMoveNotation(MoveNotation mn)
          set the move notation style you wish the output to be in.
abstract  void writeBoard(Board b)
          write the current Board to the output buffer
abstract  void writeGame(Game g)
          write the full game (GameInfo, History & Board) to the output buffer.
abstract  void writeGameInfo(GameInfo gi)
          write the GameInfo to the output buffer
abstract  void writeHistory(History h)
          write the game History to the output buffer
 
Methods inherited from class java.io.PrintWriter
checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println, write, write, write, write, write
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GameWriter

public GameWriter(java.io.OutputStream _out)

GameWriter

public GameWriter(java.io.Writer _out)
Method Detail

setMoveNotation

public abstract void setMoveNotation(MoveNotation mn)
set the move notation style you wish the output to be in.


getMoveNotation

public abstract MoveNotation getMoveNotation()
returns the currect move notation style.


setExportVariations

public abstract void setExportVariations(boolean t)
should variations be presented in the Writer's output or not.


isExportVariations

public abstract boolean isExportVariations()
is variation data presented in the Writer's output or not.


setExportComments

public abstract void setExportComments(boolean t)
are comments presented in the Writer's output or not.


isExportComments

public abstract boolean isExportComments()
will comments be presented in the output.


writeGame

public abstract void writeGame(Game g)
                        throws java.io.IOException
write the full game (GameInfo, History & Board) to the output buffer.

Throws:
java.io.IOException

writeGameInfo

public abstract void writeGameInfo(GameInfo gi)
                            throws java.io.IOException
write the GameInfo to the output buffer

Throws:
java.io.IOException

writeHistory

public abstract void writeHistory(History h)
                           throws java.io.IOException
write the game History to the output buffer

Throws:
java.io.IOException

writeBoard

public abstract void writeBoard(Board b)
                         throws java.io.IOException
write the current Board to the output buffer

Throws:
java.io.IOException

Submit a bug or feature
Visit the Website
Internet Chess ToolKit is licensed under the GPL v2 .