Package weka.gui.simplecli

Class AbstractCommand

java.lang.Object

weka.gui.simplecli.AbstractCommand

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractCommand>

Direct Known Subclasses:

Capabilities, Cls, Echo, Exit, Help, History, Java, Kill, Script, Set, Unset

public abstract class AbstractCommand
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<AbstractCommand>

Ancestor for command.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractCommand()

Method Summary

Modifier and Type	Method	Description
int	compareTo(AbstractCommand o)	Performs comparison just on the name.
boolean	equals(java.lang.Object obj)	Returns true if the object is a command with the same name.
void	execute(java.lang.String[] params)	Executes the command with the given parameters.
static AbstractCommand	getCommand(java.lang.String name)	Locates the command for the given name.
static java.util.List<AbstractCommand>	getCommands()	Returns all available commands.
abstract java.lang.String	getHelp()	Returns the help string (no indentation).
abstract java.lang.String	getName()	Returns the name of the command.
SimpleCLIPanel	getOwner()	Returns the owner.
abstract java.lang.String	getParameterHelp()	Returns the one-liner help string for the parameters.
void	setOwner(SimpleCLIPanel value)	Sets the owner.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

setOwner

public void setOwner(SimpleCLIPanel value)

Sets the owner.

Parameters:

value - the owner

getOwner

public SimpleCLIPanel getOwner()

Returns the owner.

Returns:

the owner

getName

public abstract java.lang.String getName()

Returns the name of the command.

Returns:

the name

getHelp

public abstract java.lang.String getHelp()

Returns the help string (no indentation).

Returns:

the help

getParameterHelp

public abstract java.lang.String getParameterHelp()

Returns the one-liner help string for the parameters.

Returns:

the help, empty if none available

execute

public void execute(java.lang.String[] params)
             throws java.lang.Exception

Executes the command with the given parameters. Expands any variables in the parameters.

Parameters:

params - the parameters for the command

Throws:

java.lang.Exception - if command fails

compareTo

public int compareTo(AbstractCommand o)

Performs comparison just on the name.

Specified by:

compareTo in interface java.lang.Comparable<AbstractCommand>

Parameters:

o - the other command to compare with

Returns:

less than, equal to, or greater than 0

See Also:

getName()

equals

public boolean equals(java.lang.Object obj)

Returns true if the object is a command with the same name.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other object to compare with

Returns:

true if the same

getCommands

public static java.util.List<AbstractCommand> getCommands()

Returns all available commands.

Returns:

the commands

getCommand

public static AbstractCommand getCommand(java.lang.String name)

Locates the command for the given name.

Parameters:

name - the command to look for

Returns:

the command, null if not found