Package gov.nist.secauto.metaschema.cli.processor

Class CLIProcessor

java.lang.Object

gov.nist.secauto.metaschema.cli.processor.CLIProcessor

public class CLIProcessor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CLIProcessor.CallingContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMAND_VERSION
static final org.apache.commons.cli.Option	HELP_OPTION
static final org.apache.commons.cli.Option	NO_COLOR_OPTION
static final List<org.apache.commons.cli.Option>	OPTIONS
static final org.apache.commons.cli.Option	QUIET_OPTION
static final org.apache.commons.cli.Option	SHOW_STACK_TRACE_OPTION
static final org.apache.commons.cli.Option	VERSION_OPTION

Constructor Summary

Constructors

Constructor	Description
CLIProcessor(String exec)
CLIProcessor(String exec, Map<String,IVersionInfo> versionInfos)

Method Summary

Modifier and Type	Method	Description
void	addCommandHandler(ICommand handler)
String	getExec()	Gets the command used to execute for use in help text.
protected final List<ICommand>	getTopLevelCommands()
Map<String,IVersionInfo>	getVersionInfos()	Retrieve the version information for this application.
static void	handleQuiet()
static void	main(String... args)
ExitStatus	process(String... args)	Process a set of CLIProcessor arguments.
protected void	showVersion()

Methods inherited from class java.lang.Object

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

Field Details

HELP_OPTION

@NonNull
public static final org.apache.commons.cli.Option HELP_OPTION

NO_COLOR_OPTION

@NonNull
public static final org.apache.commons.cli.Option NO_COLOR_OPTION

QUIET_OPTION

@NonNull
public static final org.apache.commons.cli.Option QUIET_OPTION

SHOW_STACK_TRACE_OPTION

@NonNull
public static final org.apache.commons.cli.Option SHOW_STACK_TRACE_OPTION

VERSION_OPTION

@NonNull
public static final org.apache.commons.cli.Option VERSION_OPTION

OPTIONS

@NonNull
public static final List<org.apache.commons.cli.Option> OPTIONS

COMMAND_VERSION

public static final String COMMAND_VERSION

See Also:

• Constant Field Values

Constructor Details

CLIProcessor

public CLIProcessor(@NonNull
 String exec)

CLIProcessor

public CLIProcessor(@NonNull
 String exec,
 @NonNull
 Map<String,IVersionInfo> versionInfos)

Method Details

main

public static void main(String... args)

getExec

@NonNull
public String getExec()

Gets the command used to execute for use in help text.

Returns:

the command name

getVersionInfos

@NonNull
public Map<String,IVersionInfo> getVersionInfos()

Retrieve the version information for this application.

Returns:

the versionInfo

addCommandHandler

public void addCommandHandler(@NonNull
 ICommand handler)

process

@NonNull
public ExitStatus process(String... args)

Process a set of CLIProcessor arguments.

process().getExitCode().getStatusCode()

Parameters:

args - the arguments to process

Returns:

the exit status

getTopLevelCommands

protected final List<ICommand> getTopLevelCommands()

handleQuiet

public static void handleQuiet()

showVersion

protected void showVersion()