PamController.command

Class ExtCommand

java.lang.Object

PamController.command.ExtCommand

Direct Known Subclasses:

ExitCommand, KillCommand, PingCommand, StartCommand, StatusCommand, StopCommand, SummaryCommand

public abstract class ExtCommand
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ExtCommand(java.lang.String name, boolean immediate)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExecute()
abstract boolean	execute() Execute the command
boolean	executeCommand() Execute the command.
java.lang.String	getName()
java.lang.String	getReturnString() Get the return string from the command.
boolean	isImmediate()
void	setImmediate(boolean immediate)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtCommand

public ExtCommand(java.lang.String name,
          boolean immediate)

Parameters:

name - Name of command (must be a single word)

immediate - immediate execution. If false, then the command will be queued in the AWT thread for later execution (SwingUtilitiies.invokeLater(...)

Method Detail

canExecute

public boolean canExecute()

Returns:

true if the command can be executed (may depend on PAMGuard status)

executeCommand

public final boolean executeCommand()

Execute the command.

Note that if immediate is set false, then the command will be executed later in the AWT thread and this function will return true.

Returns:

true if the command executed OK, or if it was sent off to execute in a later thread.

execute

public abstract boolean execute()

Execute the command

Returns:

true if command executed correctly.

getReturnString

public java.lang.String getReturnString()

Get the return string from the command.

By default this is just the command name, but many commands will need to send back extensive information.

Returns:

command output information

getName

public java.lang.String getName()

Returns:

the name of the command

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

isImmediate

public boolean isImmediate()

Returns:

true if execution is immediate (i.e. not later in the swing thread).

setImmediate

public void setImmediate(boolean immediate)

Parameters:

immediate: - true if execution should be immediate (i.e. not later in the swing thread).