com.logicbig.cli.shell

Class QuickCLIShell

java.lang.Object

com.logicbig.cli.shell.QuickCLIShell

public class QuickCLIShell
extends Object

An easy to use Command Line Interface for Shell applications. The commands are based on linux standard syntax.

CommandName [Options]... [Option-Flags]... [Arguments]... 

where

1. Options are key value pairs e.g. --opt1=theOptValue
2. Options-Flags are boolean flags e.g. -f -t -c etc. They can be combined together as -ftc
3. Arguments are input to the command e.g. consider linux command "ls -l fileName ", here fileName is the argument to the ls command

Author:

Joe Khan.

Constructor Summary

Constructors

Constructor and Description
QuickCLIShell(String name, String description)

Method Summary

Modifier and Type	Method and Description
static ConsoleWriter	getWriter() Resturn the instance of ConsoleWriter.
void	scanCommands(Class<?>... classesToBeScanned) Scans the classes for commands and does the necessary initializing for the shell application.
void	start() Starts the Shell application
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QuickCLIShell

public QuickCLIShell(String name,
                     String description)

Method Detail

start

public void start()

Starts the Shell application

scanCommands

public void scanCommands(Class<?>... classesToBeScanned)

Scans the classes for commands and does the necessary initializing for the shell application.

Parameters:

classesToBeScanned -

getWriter

public static ConsoleWriter getWriter()

Resturn the instance of ConsoleWriter.

Returns:

Console Writer

toString

public String toString()

Overrides:

toString in class Object