com.sshtools.server.vshell.commands

Class AbstractFileCommand

java.lang.Object

com.sshtools.server.vshell.AbstractCommand

com.sshtools.server.vshell.ShellCommand

com.sshtools.server.vshell.commands.AbstractFileCommand

All Implemented Interfaces:

Command, Completor

Direct Known Subclasses:

Cat, Cd

public abstract class AbstractFileCommand
extends ShellCommand

Field Summary

Fields inherited from class com.sshtools.server.vshell.ShellCommand

SUBSYSTEM_CALLBACK, SUBSYSTEM_FILESYSTEM, SUBSYSTEM_HELP, SUBSYSTEM_JVM, SUBSYSTEM_POLICY, SUBSYSTEM_SHELL, SUBSYSTEM_SSHD, SUBSYSTEM_SYSTEM, SUBSYSTEM_TEXT_EDITING

Fields inherited from class com.sshtools.server.vshell.AbstractCommand

exitCode, process

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

STILL_ACTIVE

Constructor Summary

Constructors

Constructor and Description
AbstractFileCommand(String name, String subsystem)
AbstractFileCommand(String name, String subsystem, String signature)
AbstractFileCommand(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.

Methods inherited from class com.sshtools.server.vshell.AbstractCommand

getCollection, getCommandName, getDescription, getExitCode, getName, getOptions, getProcess, getSignature, getSubsystem, hasFixedOptions, init, isBuiltIn, isHidden, setBuiltIn, setDescription, setName, setSignature, setSubsystem

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

Constructor Detail

AbstractFileCommand

public AbstractFileCommand(String name,
                           String subsystem)

AbstractFileCommand

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

AbstractFileCommand

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

Method Detail

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

Overrides:

complete in class AbstractCommand

Parameters:

buffer - the buffer

candidates - the List of candidates to populate

Returns:

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