org.jlab.clara.std.cli

Class AbstractCommand

java.lang.Object

org.jlab.clara.std.cli.AbstractCommand

All Implemented Interfaces:

java.lang.AutoCloseable, Command

Direct Known Subclasses:

BaseCommand

public abstract class AbstractCommand
extends java.lang.Object
implements Command

Default class for new shell commands. The name and a brief description of the command are required. The command can access to the virtual terminal used by the shell, if needed.

Field Summary

Fields

Modifier and Type	Field and Description
protected Config	config The configuration of the shell session.
protected java.lang.String	description The description of the command.
protected java.lang.String	name The name of the command.
protected org.jline.terminal.Terminal	terminal The virtual terminal used by the shell.
protected java.io.PrintWriter	writer The text-output stream of the terminal.

Fields inherited from interface org.jlab.clara.std.cli.Command

EXIT_ERROR, EXIT_SUCCESS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommand(Context context, java.lang.String name, java.lang.String description) Creates a new command.

Method Summary

Modifier and Type	Method and Description
void	close()
org.jline.reader.Completer	getCompleter() Gets a completer to generate tab-completion candidates of this command and its arguments.
java.lang.String	getDescription() Gets a brief explanation of what the command does.
java.lang.String	getName() Gets the name of the command.
void	printHelp(java.io.PrintWriter printer) Prints a detailed description of what the command does.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jlab.clara.std.cli.Command

execute

Field Detail

name

protected final java.lang.String name

The name of the command.

description

protected final java.lang.String description

The description of the command.

terminal

protected final org.jline.terminal.Terminal terminal

The virtual terminal used by the shell.

config

protected final Config config

The configuration of the shell session.

writer

protected final java.io.PrintWriter writer

The text-output stream of the terminal.

Constructor Detail

AbstractCommand

protected AbstractCommand(Context context,
                          java.lang.String name,
                          java.lang.String description)

Creates a new command.

Parameters:

context - the context of the shell session

name - the name of the command

description - the description of the command

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Command

Gets the name of the command.

Specified by:

getName in interface Command

Returns:

the name

getDescription

public java.lang.String getDescription()

Description copied from interface: Command

Gets a brief explanation of what the command does. More detailed information should be provided with Command.printHelp(java.io.PrintWriter).

Specified by:

getDescription in interface Command

Returns:

a short description of the command

getCompleter

public org.jline.reader.Completer getCompleter()

Description copied from interface: Command

Gets a completer to generate tab-completion candidates of this command and its arguments.

Specified by:

getCompleter in interface Command

Returns:

the completer for the command

printHelp

public void printHelp(java.io.PrintWriter printer)

Description copied from interface: Command

Prints a detailed description of what the command does.

Specified by:

printHelp in interface Command

Parameters:

printer - where to print the help text

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception