de.jstacs.tools.ui.cli

Class CLI

java.lang.Object

de.jstacs.tools.ui.cli.CLI

public class CLI
extends Object

Class that allows for building generic command line interface (CLI) applications based on the JstacsTool interface. The generic description of command line parameters is automatically inferred from the corresponding Parameters and ParameterSets of the JstacsTools. If this class is used for a single JstacsTool, the parameters may be supplied directly using a key=value interface. In case of multiple tools, each specific tool may be addressed by its short name (JstacsTool.getShortName()).

Author:

Jan Grau, Jens Keilwagen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CLI.SysProtocol Class for a Protocol that prints messages to System.out and warnings to System.err and additionally hold a log of all messages in a local StringBuffer that may be, e.g., stored to a file later.

Constructor Summary

Constructors

Constructor and Description
CLI(boolean[] configureThreads, JstacsTool... tools) Creates a new command line interface from a set of Jstacs tools.
CLI(JstacsTool... tools) Creates a new command line interface for the tools provided.
CLI(String opt, boolean[] configureThreads, JstacsTool... tools) Creates a new command line interface for the tools provided, where for each tool multi-threading may be configured.
CLI(String description, String opt, boolean[] configureThreads, JstacsTool... tools) Creates a new command line interface for the tools provided, where for each tool multi-threading may be configured.

Method Summary

Modifier and Type	Method and Description
void	run(String[] args) Runs this command line application with the specified arguments in args.
void	wiki() Creates the HTML code for wiki entries for the supplied tools.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLI

public CLI(JstacsTool... tools)

Creates a new command line interface for the tools provided.

Parameters:

tools - the tools

CLI

public CLI(boolean[] configureThreads,
           JstacsTool... tools)

Creates a new command line interface from a set of Jstacs tools.

Parameters:

configureThreads - if the tool at the corresponding index should be configured to use multiple threads, which also means that a parameter threads is displayed for this tool

tools - (an array of) tool(s) that can be run via the command line interface

CLI

public CLI(String opt,
           boolean[] configureThreads,
           JstacsTool... tools)

Creates a new command line interface for the tools provided, where for each tool multi-threading may be configured. Additional, required arguments when calling the tools may be specified.

Parameters:

opt - the additional arguments, may be an empty String

configureThreads - for each tool, if multi-threading option should be added to the list of parameters

tools - the tools

CLI

public CLI(String description,
           String opt,
           boolean[] configureThreads,
           JstacsTool... tools)

Creates a new command line interface for the tools provided, where for each tool multi-threading may be configured. Additional, required arguments when calling the tools may be specified.

Parameters:

description - a description of this CLI displayed on the command line

opt - the additional arguments, may be an empty String

configureThreads - for each tool, if multi-threading option should be added to the list of parameters

tools - the tools

Method Detail

run

public void run(String[] args)
         throws Exception

Runs this command line application with the specified arguments in args. This method would typically be called directly from the main method.

Parameters:

args - the arguments as supplied on the command line

Throws:

Exception - in case of an error

wiki

public void wiki()

Creates the HTML code for wiki entries for the supplied tools.