org.thales.punch.libraries.commons.cli

Class CommandLineRunner

java.lang.Object

org.thales.punch.libraries.commons.cli.CommandLineRunner

public class CommandLineRunner
extends Object

A Facility to create command line java applications.

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
CommandLineRunner()

Method Summary

Modifier and Type	Method and Description
protected void	limitedUsage(String mainCommandName) default ctor *./ public CommandLineRunner() { super(); } /** print the basic help with the list of available commands and how to gain more details using the help option, if any.
void	registerSubcommand(String subcommandName, CliCommand subcommand) Registers a new sub command.
void	runOrHelp(String mainCommandName, String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineRunner

public CommandLineRunner()

Method Detail

limitedUsage

protected void limitedUsage(String mainCommandName)

default ctor *./ public CommandLineRunner() { super(); } /** print the basic help with the list of available commands and how to gain more details using the help option, if any.

Parameters:

mainCommandName - the main top level executable name

runOrHelp

public void runOrHelp(String mainCommandName,
                      String[] args)

Parameters:

mainCommandName - the main top level executable name

args - the user provided command line args

registerSubcommand

public void registerSubcommand(String subcommandName,
                               CliCommand subcommand)

Registers a new sub command.

Parameters:

subcommandName - the sub command name

subcommand - the subcommand class instance