VASSAL.build.module.BasicLogger

All Implemented Interfaces:: Buildable, GameComponent, CommandEncoder, Logger

public class BasicLogger
extends Object
implements Logger, Buildable, GameComponent, CommandEncoder

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class BasicLogger.LogCommand

class BasicLogger.StepAction

class BasicLogger.UndoAction

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BEGIN`
`protected Command`	`beginningState`
`static String`	`END`
`protected Action`	`endLogAction`
`static String`	`LOG`
`protected List<Command>`	`logInput`
`protected List<Command>`	`logOutput`
`protected SaveMetaData`	`metadata`
`protected Action`	`newLogAction`
`protected int`	`nextInput`
`protected int`	`nextUndo`
`protected File`	`outputFile`
`static String`	`PROMPT_LOG_COMMENT`
`static String`	`PROMPT_NEW_LOG`
`static String`	`PROMPT_NEW_LOG_END`
`static String`	`PROMPT_NEW_LOG_START`
`protected static String`	`STEP_ICON`
`protected Action`	`stepAction`
`protected static String`	`UNDO_ICON`
`protected Action`	`undoAction`

Constructor Summary

Constructors

Constructor Description

BasicLogger()

Method Summary

Modifier and Type	Method	Description
`void`	`add(Buildable b)`	Adds a child component.
`void`	`addTo(Buildable b)`	Expects to be added to a `GameModule`.
`protected void`	`beginOutput()`
`void`	`build(Element e)`	Build the object
`Command`	`decode(String command)`	Translate a String into a `Command`
`void`	`enableDrawing(boolean show)`
`String`	`encode(Command c)`	Recognizes a logging command.
`Element`	`getBuildElement(Document doc)`
`Command`	`getRestoreCommand()`	When saving a game, each GameComponent should return a `Command` that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
`boolean`	`hasMoreCommands()`	Are there Input Steps yet to be replayed?
`boolean`	`isLogging()`
`void`	`log(Command c)`
`void`	`queryNewLogFile(boolean atStart)`
`void`	`remove(Buildable b)`
`void`	`setup(boolean show)`	Notify the GameComponent that a game has started/ended
`protected void`	`step()`
`protected void`	`undo()`
`void`	`write()`	Write the logfile to a file.

Methods inherited from class java.lang.Object

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

Field Details
- BEGIN
  
  public static final String BEGIN
  
  See Also:
  
  Constant Field Values
- END
  
  public static final String END
  
  See Also:
  
  Constant Field Values
- LOG
  
  public static final String LOG
  
  See Also:
  
  Constant Field Values
- PROMPT_NEW_LOG
  
  public static final String PROMPT_NEW_LOG
  
  See Also:
  
  Constant Field Values
- PROMPT_NEW_LOG_START
  
  public static final String PROMPT_NEW_LOG_START
  
  See Also:
  
  Constant Field Values
- PROMPT_NEW_LOG_END
  
  public static final String PROMPT_NEW_LOG_END
  
  See Also:
  
  Constant Field Values
- PROMPT_LOG_COMMENT
  
  public static final String PROMPT_LOG_COMMENT
  
  See Also:
  
  Constant Field Values
- STEP_ICON
  
  protected static final String STEP_ICON
  
  See Also:
  
  Constant Field Values
- UNDO_ICON
  
  protected static final String UNDO_ICON
  
  See Also:
  
  Constant Field Values
- logInput
  
  protected List<Command> logInput
- logOutput
  
  protected List<Command> logOutput
- nextInput
  
  protected int nextInput
- nextUndo
  
  protected int nextUndo
- beginningState
  
  protected Command beginningState
- outputFile
  
  protected File outputFile
- stepAction
  
  protected Action stepAction
- metadata
  
  protected SaveMetaData metadata
- undoAction
  
  protected Action undoAction
- endLogAction
  
  protected Action endLogAction
- newLogAction
  
  protected Action newLogAction
Constructor Details
- BasicLogger
  
  public BasicLogger()
Method Details
- build
  
  public void build(Element e)
  
  Description copied from interface: Buildable
  
  Build the object
  
  Specified by:
  
  build in interface Buildable
  
  Parameters:
  
  e - the XML element containing the object data
- addTo
  
  public void addTo(Buildable b)
  
  Expects to be added to a GameModule. Adds Undo, Step, and End Log buttons to the the control window toolbar. Registers KeyStrokeListeners for hotkey equivalents of each button.
  
  Specified by:
  
  addTo in interface Buildable
- getBuildElement
  
  public Element getBuildElement(Document doc)
  
  Specified by:
  
  getBuildElement in interface Buildable
  
  Returns:
  
  an XML element from which this component can be built
- add
  
  public void add(Buildable b)
  
  Description copied from interface: Buildable
  
  Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent
  
  Specified by:
  
  add in interface Buildable
- remove
  
  public void remove(Buildable b)
- setup
  
  public void setup(boolean show)
  
  Description copied from interface: GameComponent
  
  Notify the GameComponent that a game has started/ended
  
  Specified by:
  
  setup in interface GameComponent
  
  Parameters:
  
  show - if true, a game is starting. If false, then a game is ending
- isLogging
  
  public boolean isLogging()
- getRestoreCommand
  
  public Command getRestoreCommand()
  
  Description copied from interface: GameComponent
  
  When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
  
  Specified by:
  
  getRestoreCommand in interface GameComponent
- enableDrawing
  
  public void enableDrawing(boolean show)
- step
  
  protected void step()
- queryNewLogFile
  
  public void queryNewLogFile(boolean atStart)
- write
  
  public void write() throws IOException
  
  Write the logfile to a file. The file will have been selected when the logfile was begun.
  
  Throws:
  
  IOException
- beginOutput
  
  protected void beginOutput()
- undo
  
  protected void undo()
- log
  
  public void log(Command c)
  
  Specified by:
  
  log in interface Logger
- hasMoreCommands
  
  public boolean hasMoreCommands()
  
  Are there Input Steps yet to be replayed?
- encode
  
  public String encode(Command c)
  
  Recognizes a logging command. The logging command is a wrapper around an ordinary Command indicating that the wrapped command should be stored and executed in sequence (when the Step button is pressed)
  
  Specified by:
  
  encode in interface CommandEncoder
- decode
  
  public Command decode(String command)
  
  Description copied from interface: CommandEncoder
  
  Translate a String into a Command
  
  Specified by:
  
  decode in interface CommandEncoder

Modifier and Type	Class	Description
`static class`	`BasicLogger.LogCommand`
`class`	`BasicLogger.StepAction`
`class`	`BasicLogger.UndoAction`

Class BasicLogger

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details