com.sdl.context.common.cli

Class CommandLineInteraction

java.lang.Object

com.sdl.context.common.cli.CommandLineInteraction

public class CommandLineInteraction
extends Object

Base class for java command line interactions.

Note that this class can be run directly (to test raw CLI functionality) with

 java -cp target/context-engine-1.0.9-SNAPSHOT.jar com.sdl.context.common.cli.CommandLineInteraction
 

CLI can be started in debug mode with

 java -cp target/context-engine-1.0.9-SNAPSHOT.jar com.sdl.context.common.cli.CommandLineInteraction debug
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ARGUMENT_INDEX_2
protected static int	ARGUMENT_INDEX_3
protected static int	ARGUMENT_INDEX_4

Constructor Summary

Constructors

Constructor and Description
CommandLineInteraction()
CommandLineInteraction(boolean debug) Instantiates a new command line interaction.

Method Summary

Modifier and Type	Method and Description
protected void	addCommand(String usage, String description, String methodName) Adds the command.
protected void	addCommand(String usage, String description, String methodName, Object commandHandler) Adds the command.
protected boolean	ask(String... lines) Ask.
protected boolean	ask(String line) Ask.
protected void	assertTrue(String line, boolean expect) Assert true.
void	batch(Command command)
void	batch(String... lines) Handle a batch of commands.
protected void	display(String line) Display.
protected void	display(String line, boolean spaced) Display.
protected void	display(StringBuilder line) Display.
void	displayHelp(Command command) Display help message.
protected void	displayWelcome() Display Welcome message.
void	doRemote(Command command)
protected void	error(String message) Error.
protected void	fatal(Throwable t) Fatal.
Command	getCommand(String... lines) Gets the command.
Map<String,CommandConfiguration>	getCommands() Gets the commands.
boolean	getDebug()
boolean	getDisplayHelpOnStartup()
int	getLineLength()
boolean	getMaskCharacters()
String	getMaskedUserInputWithDefault(String defaultValue, String line)
int	getMaxHistoryLength()
String	getName()
protected String	getNumberRangeAsString(int start, int end) Display number range.
protected PrintStream	getOut()
int	getServerPort()
int	getServerWaitInMs()
int	getUserInputAsInt(String... lines) Gets the user input as int.
protected InputStream	getUserInputStream()
String	getUserInputWithDefault(String defaultValue, String line)
void	handleHistory(Command command)
protected void	init() After properties set.
boolean	isCommandNameCaseInsensitive()
boolean	isThrowOnException()
static void	main(String[] args) Start command line.
protected void	print(String message)
boolean	quit(Command command)
void	run() Run.
void	run(String commandAsString)
String	sendRemoteCommand(int port, String commandAsString) Send comment to remote server and return the response from the server.
void	setCommandNameCaseInsensitive(boolean commandNameCaseInsensitive)
void	setDebug(boolean debug)
void	setDisplayHelpOnStartup(boolean displayHelpOnStartup)
void	setLineLength(int lineLength)
protected void	setMaskCharacters(boolean maskCharacters)
void	setMaxHistoryLength(int maxHistoryLength)
void	setName(String name)
protected void	setPrependString(String prependString)
protected void	setServerPort(int serverPort)
protected void	setServerWaitInMs(int serverWaitInMs)
void	setThrowOnException(boolean throwOnException)
protected String	toBoldBlueString(String s)
protected String	toBoldGreenString(String s)
protected String	toBoldRedString(String s)
protected String	toBoldString(String s)
protected String	toBoldYellowString(String s)
void	toggleDebugMode(Command command) Toggle debug mode.

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENT_INDEX_2

protected static final int ARGUMENT_INDEX_2

See Also:

Constant Field Values

ARGUMENT_INDEX_3

protected static final int ARGUMENT_INDEX_3

See Also:

Constant Field Values

ARGUMENT_INDEX_4

protected static final int ARGUMENT_INDEX_4

See Also:

Constant Field Values

Constructor Detail

CommandLineInteraction

public CommandLineInteraction()

CommandLineInteraction

public CommandLineInteraction(boolean debug)

Instantiates a new command line interaction.

Method Detail

main

public static void main(String[] args)

Start command line.

addCommand

protected void addCommand(String usage,
                          String description,
                          String methodName)
                   throws CommandLineException

Adds the command.

Parameters:

usage - the usage

description - the description

methodName - the method name

Throws:

CommandLineException - the command line exception

addCommand

protected void addCommand(String usage,
                          String description,
                          String methodName,
                          Object commandHandler)
                   throws CommandLineException

Adds the command.

Parameters:

usage - the usage

description - the description

methodName - the method name

commandHandler - the command handler

Throws:

CommandLineException - the command line exception

init

protected void init()
             throws CommandLineException

After properties set.

Throws:

CommandLineException

ask

protected boolean ask(String line)
               throws IOException

Ask.

Parameters:

line - the line

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

ask

protected boolean ask(String... lines)
               throws IOException

Ask.

Parameters:

lines - the lines

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

assertTrue

protected void assertTrue(String line,
                          boolean expect)

Assert true.

Parameters:

line - the line

expect - the expect

batch

public void batch(Command command)
           throws CommandLineException

Throws:

CommandLineException

batch

public void batch(String... lines)
           throws CommandLineException

Handle a batch of commands.

Parameters:

lines - the lines

Throws:

CommandLineException - the command line exception

display

protected void display(String line)

Display.

Parameters:

line - the line

display

protected void display(String line,
                       boolean spaced)

Display.

Parameters:

line - the line

spaced - the spaced

display

protected void display(StringBuilder line)

Display.

Parameters:

line - the line

displayHelp

public void displayHelp(Command command)

Display help message.

Parameters:

command - the command

handleHistory

public void handleHistory(Command command)
                   throws CommandLineException

Throws:

CommandLineException

getNumberRangeAsString

protected String getNumberRangeAsString(int start,
                                        int end)

Display number range.

Parameters:

start - the start

end - the end

Returns:

the string

displayWelcome

protected void displayWelcome()

Display Welcome message.

error

protected void error(String message)

Error.

Parameters:

message - the message

fatal

protected void fatal(Throwable t)

Fatal.

Parameters:

t - the t

getCommand

public Command getCommand(String... lines)
                   throws IOException

Gets the command.

Parameters:

lines - the lines

Returns:

the command

Throws:

IOException - Signals that an I/O exception has occurred.

getCommands

public Map<String,CommandConfiguration> getCommands()

Gets the commands.

Returns:

the commands

getDisplayHelpOnStartup

public boolean getDisplayHelpOnStartup()

setDisplayHelpOnStartup

public void setDisplayHelpOnStartup(boolean displayHelpOnStartup)

getLineLength

public int getLineLength()

setLineLength

public void setLineLength(int lineLength)

getMaxHistoryLength

public int getMaxHistoryLength()

Returns:

the maxHistoryLength

setMaxHistoryLength

public void setMaxHistoryLength(int maxHistoryLength)

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

setPrependString

protected void setPrependString(String prependString)

getUserInputWithDefault

public String getUserInputWithDefault(String defaultValue,
                                      String line)

getMaskedUserInputWithDefault

public String getMaskedUserInputWithDefault(String defaultValue,
                                            String line)

getUserInputAsInt

public int getUserInputAsInt(String... lines)
                      throws IOException

Gets the user input as int.

Parameters:

lines - the lines

Returns:

the user input as int

Throws:

IOException - Signals that an I/O exception has occurred.

getUserInputStream

protected InputStream getUserInputStream()

getOut

protected PrintStream getOut()

isThrowOnException

public boolean isThrowOnException()

Returns:

the throwOnException

setThrowOnException

public void setThrowOnException(boolean throwOnException)

Parameters:

throwOnException - the throwOnException to set

quit

public boolean quit(Command command)

run

public void run()

Run.

run

public void run(String commandAsString)

getDebug

public boolean getDebug()

setDebug

public void setDebug(boolean debug)

toBoldString

protected String toBoldString(String s)

toBoldRedString

protected String toBoldRedString(String s)

toBoldGreenString

protected String toBoldGreenString(String s)

toBoldYellowString

protected String toBoldYellowString(String s)

toBoldBlueString

protected String toBoldBlueString(String s)

getMaskCharacters

public boolean getMaskCharacters()

setMaskCharacters

protected void setMaskCharacters(boolean maskCharacters)

toggleDebugMode

public void toggleDebugMode(Command command)

Toggle debug mode.

Parameters:

command - the command

doRemote

public void doRemote(Command command)
              throws IOException

Throws:

IOException

sendRemoteCommand

public String sendRemoteCommand(int port,
                                String commandAsString)
                         throws IOException

Send comment to remote server and return the response from the server.

Parameters:

port - port number

commandAsString - command as a string

Returns:

output from remote command

Throws:

IOException

isCommandNameCaseInsensitive

public boolean isCommandNameCaseInsensitive()

Returns:

the commandNameCaseInsensitive

setCommandNameCaseInsensitive

public void setCommandNameCaseInsensitive(boolean commandNameCaseInsensitive)

Parameters:

commandNameCaseInsensitive - the commandNameCaseInsensitive to set

getServerPort

public int getServerPort()

Returns:

the getServerPort

setServerPort

protected void setServerPort(int serverPort)

Parameters:

serverPort - the server port to set

getServerWaitInMs

public int getServerWaitInMs()

setServerWaitInMs

protected void setServerWaitInMs(int serverWaitInMs)

print

protected void print(String message)