Class PrivMsgCommand

java.lang.Object

VASSAL.command.Command

VASSAL.chat.PrivMsgCommand

public class PrivMsgCommand
extends Command

A Command that encapsulates a private chat message from another SimplePlayer

Constructor Summary

Constructors

Constructor	Description
PrivMsgCommand(PrivateChatManager mgr, Player sender, String msg)

Method Summary

Modifier and Type	Method	Description
void	executeCommand()	Perform the action which this Command represents
String	getMessage()
Player	getSender()
boolean	isLoggable()	Return true, as this command should not be logged
Command	myUndoCommand()	If the action can be undone, return a Command that performs the inverse action.

Methods inherited from class Command

append, execute, getDetails, getSubCommands, getUndoCommand, isAtomic, isNull, isNullOrContainsOnly, stripSubCommands, toString

Modifier and Type	Method	Description
Command	append(Command c)	Append a subcommand to this Command.
void	execute()	Execute this command by first invoking Command.executeCommand(), then invoking itself recursively on all subcommands.
String	getDetails()	Detailed information for toString()
Command[]	getSubCommands()
Command	getUndoCommand()
protected boolean	isAtomic()	Return true if this command has no sub-commands attached to it (other than null commands).
boolean	isNull()
boolean	isNullOrContainsOnly(Class<?> target)	Return true if this Command is a NullCommand or only contains Null Commands or commands of the same type as target
void	stripSubCommands()	Remove all subcommands.
String	toString()

Methods inherited from class Object

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

Constructor Details

PrivMsgCommand

public PrivMsgCommand(PrivateChatManager mgr,
 Player sender,
 String msg)

Method Details

executeCommand

public void executeCommand()

Description copied from class: Command

Perform the action which this Command represents

Specified by:

executeCommand in class Command

myUndoCommand

public 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

isLoggable

public boolean isLoggable()

Return true, as this command should not be logged

Overrides:

isLoggable in class Command

Returns:

true if this command should be stored in a logfile

getSender

public Player getSender()

getMessage

public String getMessage()