edu.illinois.cs.cogcomp.core.utilities.commands

Class InteractiveShell<T>

java.lang.Object

edu.illinois.cs.cogcomp.core.utilities.commands.InteractiveShell<T>

Type Parameters:

T - The class that contains all the commands.

public class InteractiveShell<T>
extends Object

This class provides an easy way provide command line interface to the program. It exposes all the static methods of a class (that is the template parameter) to the command line interface.

Additionally, it also prints documentation if necessary.

Usage: Create a class called AllCommands

 class AllCommands {
 
   @CommandDescription(description = "Does foo to bar");
      public static Foo(String bar) {
          ...
      }
  }
  
 

Create the main function somewhere

 public static void main(String[] args) throws Exception {
     InteractiveShell<AllCommands> tester = new InteractiveShell<AllCommands>(AllCommands.class);
 
     if (args.length == 0)
         tester.showDocumentation();
     else
         tester.runCommand(args);
 }
 

Now, command line options can be added to the program by adding static functions to AllCommands.

Author:

vivek

Constructor Summary

Constructors

Constructor and Description
InteractiveShell(Class<T> className) Create a new interactive shell for type T

Method Summary

Modifier and Type	Method and Description
void	runCommand(String[] args) Runs a command.
void	showDocumentation() Displays the available static commands along with their documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractiveShell

public InteractiveShell(Class<T> className)

Create a new interactive shell for type T

Parameters:

className - The class of type T

Method Detail

showDocumentation

public void showDocumentation()

Displays the available static commands along with their documentation. The documentation is drawn from the function's CommandDescription.

runCommand

public void runCommand(String[] args)
                throws Exception

Runs a command.

The command is specified by the first element of the argument and its parameters are the rest of the elements.

Note: This demands that all the parameters should be strings.

Parameters:

args - An array of strings. The name of the command should be the first element and its parameters should follow.

Throws:

Exception