com.milaboratory.cli

Class JCommanderBasedMain

java.lang.Object

com.milaboratory.cli.JCommanderBasedMain

All Implemented Interfaces:

ActionHelper

public class JCommanderBasedMain
extends Object
implements ActionHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JCommanderBasedMain.MainParameters
static class	JCommanderBasedMain.MainParametersWithVersion
static class	JCommanderBasedMain.ProcessResult

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Action>	actions
protected String[]	arguments
protected String	command
protected Runnable	fullVersionInfoCallback
protected PrintStream	outputStream
protected boolean	printHelpOnError
protected boolean	printStackTrace
protected Runnable	shortVersionInfoCallback

Constructor Summary

Constructors

Constructor and Description
JCommanderBasedMain(String command, Action... actions)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCommandLineArguments()
PrintStream	getDefaultPrintStream()
boolean	isPrintStackTrace()
JCommanderBasedMain.ProcessResult	main(String... args)
protected void	printActionHelp(com.beust.jcommander.JCommander commander, Action action)
protected void	printException(RuntimeException e, com.beust.jcommander.JCommander commander, Action action)
protected void	printGlobalHelp()
protected void	reg(Action a)
void	removeVersionInfoCallback() Removes -v / --version option callbacks, and removes option by itself.
void	setOutputStream(PrintStream outputStream)
void	setPrintStackTrace(boolean printStackTrace)
void	setVersionInfoCallback(Runnable versionInfoCallback) Enables -v / --version parameter.
void	setVersionInfoCallback(Runnable shortVersionInfoCallback, Runnable fullVersionInfoCallback) Enables -v / --version parameter.

Methods inherited from class java.lang.Object

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

Field Detail

actions

protected final Map<String,Action> actions

command

protected final String command

printHelpOnError

protected boolean printHelpOnError

printStackTrace

protected boolean printStackTrace

shortVersionInfoCallback

protected Runnable shortVersionInfoCallback

fullVersionInfoCallback

protected Runnable fullVersionInfoCallback

outputStream

protected PrintStream outputStream

arguments

protected String[] arguments

Constructor Detail

JCommanderBasedMain

public JCommanderBasedMain(String command,
                   Action... actions)

Method Detail

setOutputStream

public void setOutputStream(PrintStream outputStream)

getDefaultPrintStream

public PrintStream getDefaultPrintStream()

Specified by:

getDefaultPrintStream in interface ActionHelper

getCommandLineArguments

public String getCommandLineArguments()

Specified by:

getCommandLineArguments in interface ActionHelper

isPrintStackTrace

public boolean isPrintStackTrace()

setPrintStackTrace

public void setPrintStackTrace(boolean printStackTrace)

reg

protected void reg(Action a)

main

public JCommanderBasedMain.ProcessResult main(String... args)
                                       throws Exception

Throws:

Exception

printGlobalHelp

protected void printGlobalHelp()

printActionHelp

protected void printActionHelp(com.beust.jcommander.JCommander commander,
                   Action action)

printException

protected void printException(RuntimeException e,
                  com.beust.jcommander.JCommander commander,
                  Action action)

setVersionInfoCallback

public void setVersionInfoCallback(Runnable versionInfoCallback)

Enables -v / --version parameter. Sets callback that will be invoked if this option is specified by user.

Parameters:

versionInfoCallback - callback to be will be invoked if user specified -v option

setVersionInfoCallback

public void setVersionInfoCallback(Runnable shortVersionInfoCallback,
                          Runnable fullVersionInfoCallback)

Enables -v / --version parameter. Sets separate callbacks that will be invoked if -v or --version this option is specified by user.

Parameters:

shortVersionInfoCallback - callback to be will be invoked if user specified -v option

fullVersionInfoCallback - callback to be will be invoked if user specified --version option

removeVersionInfoCallback

public void removeVersionInfoCallback()

Removes -v / --version option callbacks, and removes option by itself.