Package com.pnfsoftware.jeb.util.interpreter

Class AbstractCommandInterpreter

java.lang.Object

com.pnfsoftware.jeb.util.interpreter.AbstractCommandInterpreter

All Implemented Interfaces:

ICommandInterpreter

public abstract class AbstractCommandInterpreter
extends Object
implements ICommandInterpreter

Skeleton for a command interpreter.

Constructor Summary

Constructors

Constructor	Description
AbstractCommandInterpreter()	Create a command interpreter skeleton.

Method Summary

Modifier and Type	Method	Description
AutocompletionResult	autoComplete(String command)	Provide a best-effort completion suggestion for the provided partial command.
String	getBanner()	Retrieve the interpreter's banner/logo string.
String	getDescription()	Get the long name or description.
void	prepare()	Interpreters may place resource intensive preparation operations here.
boolean	shouldDisplayRawResults()	Determine whether this interpreter prefers that the results of executed commands be printed as-is.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pnfsoftware.jeb.util.interpreter.ICommandInterpreter

executeCommand, getName

Constructor Details

AbstractCommandInterpreter

public AbstractCommandInterpreter()

Create a command interpreter skeleton.

Method Details

getDescription

public String getDescription()

Description copied from interface: ICommandInterpreter

Get the long name or description.

Specified by:

getDescription in interface ICommandInterpreter

Returns:

optional string

getBanner

public String getBanner()

Description copied from interface: ICommandInterpreter

Retrieve the interpreter's banner/logo string.

Specified by:

getBanner in interface ICommandInterpreter

Returns:

optional string that client code (shells) may display when the interpreter was just instantiated

prepare

public void prepare()

Description copied from interface: ICommandInterpreter

Interpreters may place resource intensive preparation operations here. Clients may optionally call this method before invoking either: ICommandInterpreter.executeCommand(String) or ICommandInterpreter.autoComplete(String). Clients may decide to not call this method. An interpreter implementation must handle cases where prepare() is never called, sometimes called, called multiple times, etc.

Specified by:

prepare in interface ICommandInterpreter

shouldDisplayRawResults

public boolean shouldDisplayRawResults()

Description copied from interface: ICommandInterpreter

Determine whether this interpreter prefers that the results of executed commands be printed as-is. Clients decide whether or not they want to follow this guideline.

Specified by:

shouldDisplayRawResults in interface ICommandInterpreter

Returns:

true if clients should display execution results without additional formatting

autoComplete

public AutocompletionResult autoComplete(String command)

Description copied from interface: ICommandInterpreter

Provide a best-effort completion suggestion for the provided partial command.

Specified by:

autoComplete in interface ICommandInterpreter

Parameters:

command - partial command line

Returns:

optional auto-completion result object