com.sshtools.server.vshell

Class AbstractCommand

java.lang.Object

com.sshtools.server.vshell.AbstractCommand

All Implemented Interfaces:

Command, Completor

Direct Known Subclasses:

ShellCommand

public abstract class AbstractCommand
extends Object
implements Command

Field Summary

Fields

Modifier and Type	Field and Description
protected int	exitCode
protected VirtualProcess	process

Fields inherited from interface com.sshtools.server.vshell.Command

STILL_ACTIVE

Constructor Summary

Constructors

Constructor and Description
AbstractCommand(String name, String subsystem)
AbstractCommand(String name, String subsystem, String signature)
AbstractCommand(String name, String subsystem, String signature, org.apache.commons.cli.Option... options)

Method Summary

Modifier and Type	Method and Description
int	complete(String buffer, int cursor, List<String> candidates) Populates candidates with a list of possible completions for the buffer.
List<String>	getCollection(int i)
String	getCommandName()
String	getDescription()
int	getExitCode()
String	getName()
org.apache.commons.cli.Options	getOptions()
VirtualProcess	getProcess()
String	getSignature()
String	getSubsystem()
boolean	hasFixedOptions()
void	init(VirtualProcess process)
boolean	isBuiltIn()
boolean	isHidden()
protected void	setBuiltIn(boolean builtIn)
protected void	setDescription(String description)
protected void	setName(String name)
protected void	setSignature(String signature)
protected void	setSubsystem(String subsystem)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sshtools.server.vshell.Command

run

Field Detail

process

protected VirtualProcess process

exitCode

protected int exitCode

Constructor Detail

AbstractCommand

public AbstractCommand(String name,
                       String subsystem)

AbstractCommand

public AbstractCommand(String name,
                       String subsystem,
                       String signature)

AbstractCommand

public AbstractCommand(String name,
                       String subsystem,
                       String signature,
                       org.apache.commons.cli.Option... options)

Method Detail

init

public void init(VirtualProcess process)

Specified by:

init in interface Command

isHidden

public boolean isHidden()

Specified by:

isHidden in interface Command

getProcess

public VirtualProcess getProcess()

complete

public int complete(String buffer,
                    int cursor,
                    List<String> candidates)

Description copied from interface: Completor

Populates candidates with a list of possible completions for the buffer. The candidates list will not be sorted before being displayed to the user: thus, the complete method should sort the List before returning.

Specified by:

complete in interface Completor

Parameters:

buffer - the buffer

candidates - the List of candidates to populate

Returns:

the index of the buffer for which the completion will be relative

getName

public String getName()

hasFixedOptions

public boolean hasFixedOptions()

getOptions

public org.apache.commons.cli.Options getOptions()

Specified by:

getOptions in interface Command

getDescription

public String getDescription()

Specified by:

getDescription in interface Command

getSubsystem

public String getSubsystem()

Specified by:

getSubsystem in interface Command

getCommandName

public String getCommandName()

Specified by:

getCommandName in interface Command

getSignature

public String getSignature()

Specified by:

getSignature in interface Command

getCollection

public List<String> getCollection(int i)
                           throws Exception

Throws:

Exception

isBuiltIn

public boolean isBuiltIn()

Specified by:

isBuiltIn in interface Command

setBuiltIn

protected void setBuiltIn(boolean builtIn)

setName

protected void setName(String name)

setSubsystem

protected void setSubsystem(String subsystem)

setSignature

protected void setSignature(String signature)

setDescription

protected void setDescription(String description)

getExitCode

public int getExitCode()

Specified by:

getExitCode in interface Command