Package VASSAL.command

Class ChangePiece

java.lang.Object

VASSAL.command.Command

VASSAL.command.ChangePiece

public class ChangePiece
extends Command

This Command changes the state of a GamePiece. Its undo Command is another ChangePiece with the new and old states reversed.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	newState
protected String	oldState

Constructor Summary

Constructors

Constructor	Description
ChangePiece(String id, String newState)	Deprecated, for removal: This API element is subject to removal in a future version.
ChangePiece(String id, String oldState, String newState)

Method Summary

Modifier and Type	Method	Description
Command	append(Command c)	Append a subcommand to this Command.
protected void	executeCommand()	Changes the state of a GamePiece by invoking GamePiece.setState(java.lang.String)
String	getDetails()	Detailed information for toString()
String	getId()
String	getNewState()
String	getOldState()
boolean	isNull()
protected Command	myUndoCommand()	If the action can be undone, return a Command that performs the inverse action.

Methods inherited from class VASSAL.command.Command

execute, getSubCommands, getUndoCommand, hasNullSubcommands, isAtomic, isLoggable, stripSubCommands, toString

Methods inherited from class java.lang.Object

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

Field Details

newState

protected String newState

oldState

protected String oldState

Constructor Details

ChangePiece

public ChangePiece(String id,
String oldState,
String newState)

Parameters:

id - the id of the GamePiece to change

oldState - the previous state of the piece

newState - the new state of the piece

ChangePiece

@Deprecated(since="2020-08-06",
            forRemoval=true)
public ChangePiece(String id,
String newState)

Deprecated, for removal: This API element is subject to removal in a future version.

When using this constructor, the previous state will be set to that of the piece when this Command is executed.

Method Details

executeCommand

protected void executeCommand()

Changes the state of a GamePiece by invoking GamePiece.setState(java.lang.String)

Specified by:

executeCommand in class Command

append

public Command append(Command c)

Description copied from class: Command

Append a subcommand to this Command.

Overrides:

append in class Command

myUndoCommand

protected Command myUndoCommand()

Description copied from class: Command

If the action can be undone, return a Command that performs the inverse action. The Command returned should only undo Command.executeCommand(), not the actions of subcommands

Specified by:

myUndoCommand in class Command

getId

public String getId()

getNewState

public String getNewState()

getOldState

public String getOldState()

isNull

public boolean isNull()

Overrides:

isNull in class Command

Returns:

true if this command does nothing

getDetails

public String getDetails()

Description copied from class: Command

Detailed information for toString()

Overrides:

getDetails in class Command