org.thales.punch.libraries.commons.cli

Class CliCommand

java.lang.Object

org.thales.punch.libraries.commons.cli.CliCommand

public abstract class CliCommand
extends Object

Facility Class to create a java command line application. To use it you must extend it and implement a run() method. Here is an example :

 public final class Main  extends CliCommand {
         @Parameter(names = {"--name","-n"}, required = true, description = "an example mandatory parameter")
        private String name = null;
 
        // implement the run method
         @Override
        public void run() {
                ...
        }
 
        // then implement your main entry point like this
        public static void main(String... args) {
          CommandLineRunner c = new CommandLineRunner();
          c.registerSubcommand("daemon", new Main());
          c.runOrHelp("punchplatform-shiva.sh", args);
        }
 }
 

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
CliCommand()

Method Summary

Modifier and Type	Method and Description
protected void	printUsage()
protected abstract void	run() The actual execution of the command if all required parameters are here.
protected void	runOrHelp(com.beust.jcommander.JCommander invoker) This is called from the CommandLineRunner.

Methods inherited from class java.lang.Object

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

Constructor Detail

CliCommand

public CliCommand()

Method Detail

printUsage

protected void printUsage()

runOrHelp

protected void runOrHelp(com.beust.jcommander.JCommander invoker)

This is called from the CommandLineRunner.

Parameters:

invoker - the invoker

run

protected abstract void run()

The actual execution of the command if all required parameters are here. XXXXXXXXX not good idea to use run(), which usually indicates a Runnable. XXXXXXXXX when browsing java code it is confusing. Prefer something else i.e. execute()