com.chemaxon.overlap.cli.invocation

Interface CliInvocationSpec<PT>

Type Parameters:

PT - Type of CLI parameters class

@Beta
public interface CliInvocationSpec<PT>

Specify command line invocation.

Method Summary

Modifier and Type	Method and Description
<ET extends Exception> CliInvocationSpec<PT>	handle(Class<ET> exceptionClass, Consumer<ET> handler) Register exception handler.
void	launch(CliEntry<PT> launcher) Launch main method.
<ST> CliInvocationSpec2<PT,ST>	statProf(Class<ST> statClass) Specify execution statistics type.
CliInvocationSpec<PT>	usage(Supplier<String> usageHelp) Specify usage.

Method Detail

handle

<ET extends Exception> CliInvocationSpec<PT> handle(Class<ET> exceptionClass,
                                                    Consumer<ET> handler)

Register exception handler.

Type Parameters:

ET - Exception type

Parameters:

exceptionClass - Exception type to handle

handler - Handler

Returns:

Invocation spec

launch

void launch(CliEntry<PT> launcher)

Launch main method.

Parameters:

launcher - Entry point to launch with the parsed CLI parameters

usage

CliInvocationSpec<PT> usage(Supplier<String> usageHelp)

Specify usage. A typical implementation checks if parameter help. When it is true prints help and returns a nullary instance (which methods does nothing) effectively terminating execution.

Required field of the CLI parameters object are:

• boolean help - Print command line help and exit. The annotated Parameter.help() must be true.)

Parameters:

usageHelp - Supplier of usage help. Implementation is excpected to be free of side effects.

Returns:

Invocation spec

statProf

<ST> CliInvocationSpec2<PT,ST> statProf(Class<ST> statClass)

Specify execution statistics type. Required fields of the statistics class:

• String [] cliArguments - Command line arguments
• <PT> cliParameters - Parsed parameters object
• Map<String, String> env - Environment variables
• Map<String, String> props - System properties
• long startTime - Launch time
• long stopTime - Finishing time
• long elapsedTime - Elapsed time in ms
• Memstat memstatInitial - Memstat taken on/around startup
• Memstat memstatFinal - Memstat taken after finishing
• ProfSnapshot profSnapshotInitial - Profiler snapshot taken on/around startup
• ProfSnapshot profSnapshotFinal - Profiler snapshot taken on/around finishing

When using this method additional fields in the CLI parameters object are requested:

• String stat - Optional file name to write execution statistics
• String prof - Optional file name to write profiling and statistics
• int profres - Resolution of the profiling info. Update time between snapshot writes in ms
• boolean statGcInitial - Invoke GC on initial memory/profiling snapshots
• boolean statGcFinal - Invoke GC on final memory/profiling snapshots

Type Parameters:

ST - Type of execution statistics

Parameters:

statClass - Type of execution statistics

Returns:

Execution statistics aware invocation spec