Index (Metaschema CLI Framework 2.2.0 API)

A C D E F G H I M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCommandExecutor - Class in gov.nist.secauto.metaschema.cli.processor.command: A base class for implementation that perform the operation supported by a command.
AbstractCommandExecutor(CLIProcessor.CallingContext, CommandLine) - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor: Construct a new command executor.
AbstractExitStatus - Class in gov.nist.secauto.metaschema.cli.processor: Records information about the exit status of a CLI command.
AbstractExitStatus(ExitCode) - Constructor for class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus: Construct a new exit status based on the provided exitCode.
AbstractParentCommand - Class in gov.nist.secauto.metaschema.cli.processor.command: A base class for a command that supports hierarchical command structure with child commands.
AbstractParentCommand() - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand: Construct a new parent command.
AbstractTerminalCommand - Class in gov.nist.secauto.metaschema.cli.processor.command: A base class for terminal commands in the command processing hierarchy.
AbstractTerminalCommand() - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand
addCommandHandler(ICommand) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Register a new command handler.
addCommandHandler(ICommand) - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand: Add a child command.

C

CLIProcessor - Class in gov.nist.secauto.metaschema.cli.processor: Processes command line arguments and dispatches called commands.
CLIProcessor(String) - Constructor for class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: The main entry point for CLI processing.
CLIProcessor(String, Map<String, IVersionInfo>) - Constructor for class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: The main entry point for CLI processing.
CLIProcessor.CallingContext - Class in gov.nist.secauto.metaschema.cli.processor: Records information about the command line options and called command hierarchy.
COMMAND_VERSION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Used to identify the version info for the command.
CommandExecutionException - Exception in gov.nist.secauto.metaschema.cli.processor.command: For use in commands to short-circut command execution.
CommandExecutionException(ExitCode) - Constructor for exception gov.nist.secauto.metaschema.cli.processor.command.CommandExecutionException: Constructs a new exception with the provided code, and no message or cause.
CommandExecutionException(ExitCode, String) - Constructor for exception gov.nist.secauto.metaschema.cli.processor.command.CommandExecutionException: Constructs a new exception with the provided code, message, and no cause.
CommandExecutionException(ExitCode, String, Throwable) - Constructor for exception gov.nist.secauto.metaschema.cli.processor.command.CommandExecutionException: Constructs a new exception with the provided code, message, and cause.
CommandExecutionException(ExitCode, Throwable) - Constructor for exception gov.nist.secauto.metaschema.cli.processor.command.CommandExecutionException: Constructs a new exception with no message and the provided code and cause.
CommandService - Class in gov.nist.secauto.metaschema.cli.processor.command: A service that loads commands using SPI.

D

DefaultExtraArgument - Class in gov.nist.secauto.metaschema.cli.processor.command.impl: A default implementation of the ExtraArgument interface that represents a named command-line argument which can be marked as required or optional.
DefaultExtraArgument(String, boolean) - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.impl.DefaultExtraArgument: Construct a new instance.

E

execute() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor
execute() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommandExecutor: Execute the command operation.
execute(CLIProcessor.CallingContext, CommandLine) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommandExecutor.ExecutionFunction: Execute a command operation.
exit() - Method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Exit without a message.
ExitCode - Enum in gov.nist.secauto.metaschema.cli.processor: An enumeration of supported exit code values.
exitMessage() - Method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Exit with the associated message.
exitMessage(Object...) - Method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Exit with the associated message and message arguments.
ExitStatus - Interface in gov.nist.secauto.metaschema.cli.processor: Implementations provide details around the result of processing a set of command line arguments.
ExtraArgument - Interface in gov.nist.secauto.metaschema.cli.processor.command: A representation of an extra, non-option command line argument.

F

FAIL - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: The command executed properly, but the operation failed.

G

gatherOptions() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Used to gather options directly associated with this command.
generateMessage(boolean) - Method in class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus: Generates and logs a message based on the current exit status.
generateMessage(boolean) - Method in interface gov.nist.secauto.metaschema.cli.processor.ExitStatus: Process the exit status.
getBuildTimestamp() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getCallingContext() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor: Get the context of the command execution, which provides access to the execution environment needed for command processing.
getCLIProcessor() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Get the command line processor instance that generated this calling context.
getCommand() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor: Get the command associated with this execution.
getCommandLine() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor: Get the parsed command line details containing the command options and arguments provided by the user during execution.
getCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.command.CommandService: Get the loaded commands.
getCurrentWorkingDirectory() - Static method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand: A utility method that can be used to get the current working directory.
getDescription() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Get a description of what the command does.
getExec() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Gets the command used to execute for use in help text.
getExitCode() - Method in class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus
getExitCode() - Method in interface gov.nist.secauto.metaschema.cli.processor.ExitStatus: Get the exit code information associated with this exit status.
getExtraArguments() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Get the non-option arguments.
getGitBranch() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getGitClosestTag() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getGitCommit() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getGitOriginUrl() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getInstance() - Static method in class gov.nist.secauto.metaschema.cli.processor.command.CommandService: Get the singleton instance of the function service.
getMessage() - Method in interface gov.nist.secauto.metaschema.cli.processor.ExitStatus: Get the associated message, or null if there is no message.
getMessage() - Method in class gov.nist.secauto.metaschema.cli.processor.MessageExitStatus
getMessage() - Method in class gov.nist.secauto.metaschema.cli.processor.NonMessageExitStatus: Get the associated message, or null if there is no message.
getName() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument: Get the argument name.
getName() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Get the name of the command.
getName() - Method in class gov.nist.secauto.metaschema.cli.processor.command.impl.DefaultExtraArgument
getName() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getNumber() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument: Get the allow number of arguments of this type.
getOption() - Method in exception gov.nist.secauto.metaschema.cli.processor.InvalidArgumentException: Return the option requiring an argument that wasn't provided on the command line.
getStatusCode() - Method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Get the related status code for use with System.exit(int).
getSubCommandByName(String) - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
getSubCommandByName(String) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Get a sub-command by it's command name.
getSubCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
getSubCommands() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Get any sub-commands associated with this command.
getTargetCommand() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Get the command that was triggered by the CLI arguments.
getThrowable() - Method in class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus: Get the associated throwable.
getThrowable() - Method in interface gov.nist.secauto.metaschema.cli.processor.ExitStatus: Get a throwable that is associated with this exit status.
getTopLevelCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Get the root-level commands.
getTopLevelCommandsByName() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Get the root-level commands, mapped from name to command.
getVersion() - Method in class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion
getVersionInfos() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Retrieve the version information for this application.
gov.nist.secauto.metaschema.cli.processor - package gov.nist.secauto.metaschema.cli.processor
gov.nist.secauto.metaschema.cli.processor.command - package gov.nist.secauto.metaschema.cli.processor.command
gov.nist.secauto.metaschema.cli.processor.command.impl - package gov.nist.secauto.metaschema.cli.processor.command.impl

H

handleError(ExitStatus, CommandLine, boolean) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Handle an error that occurred while executing the command.
handleInvalidCommand(String) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Generate the help message and exit status for an invalid command using the provided message.
handleQuiet() - Static method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Configure the logger to only report errors.
HELP_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: This option indicates if the help should be shown.

I

ICommand - Interface in gov.nist.secauto.metaschema.cli.processor.command: A command line interface command.
ICommandExecutor - Interface in gov.nist.secauto.metaschema.cli.processor.command: An abstract base class that implements the ICommandExecutor interface, providing common functionality for command execution implementations.
ICommandExecutor.ExecutionFunction - Interface in gov.nist.secauto.metaschema.cli.processor.command: This functional interface represents a method that is used to execute a command operation.
INVALID_ARGUMENTS - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: The provided argument information for a command fails to match argument use requirements.
INVALID_COMMAND - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: A command was requested by name that doesn't exist or required arguments are missing.
INVALID_TARGET - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: The target argument was not found or invalid.
InvalidArgumentException - Exception in gov.nist.secauto.metaschema.cli.processor: Thrown when an option argument is found to be invalid during parsing of a command-line.
InvalidArgumentException(String) - Constructor for exception gov.nist.secauto.metaschema.cli.processor.InvalidArgumentException: Generate a new exception.
IO_ERROR - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: An error occurred while reading or writing.
isRequired() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument: Get if the argument is required.
isRequired() - Method in class gov.nist.secauto.metaschema.cli.processor.command.impl.DefaultExtraArgument
isSubCommandRequired() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
isSubCommandRequired() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Determine if this command requires the use of a sub-command.

M

main(String...) - Static method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: The main entry point for command execution.
MessageExitStatus - Class in gov.nist.secauto.metaschema.cli.processor: An ExitStatus implementation with an associated message.
MessageExitStatus(ExitCode, Object...) - Constructor for class gov.nist.secauto.metaschema.cli.processor.MessageExitStatus: Construct a new ExitStatus based on an array of message arguments.

N

newExecutor(CLIProcessor.CallingContext, CommandLine) - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
newExecutor(CLIProcessor.CallingContext, CommandLine) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Create a new executor for this command.
newInstance(String, boolean) - Static method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument: Create a new extra argument instance.
NO_COLOR_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: This option indicates if colorized output should be disabled.
NonMessageExitStatus - Class in gov.nist.secauto.metaschema.cli.processor: An ExitStatus implementation that represents a status without an associated message.

O

OK - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: The command executed without issue.
OptionUtils - Class in gov.nist.secauto.metaschema.cli.processor: A collection of utilities for handling command line options.

P

process(String...) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Process a set of CLIProcessor arguments.
processCommand() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Process the command identified by the CLI arguments.
PROCESSING_ERROR - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Handled errors that occur during command execution.
ProcessorVersion - Class in gov.nist.secauto.metaschema.cli.processor: Provides version information for this library.
ProcessorVersion() - Constructor for class gov.nist.secauto.metaschema.cli.processor.ProcessorVersion

Q

QUIET_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: This option indicates if non-errors should be suppressed.

R

resolveAgainstCWD(String) - Static method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand: A utility method that can be used to resolve a URI (as a string) against the URI for the current working directory.
resolveAgainstCWD(URI) - Static method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand: A utility method that can be used to resolve a URI against the URI for the current working directory.
resolveAgainstCWD(Path) - Static method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand: A utility method that can be used to resolve a path against the current working directory.
RUNTIME_ERROR - Enum constant in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Unhandled errors that occur during command execution.

S

setOption(Option) - Method in exception gov.nist.secauto.metaschema.cli.processor.InvalidArgumentException: Assign the option requiring an argument that wasn't provided on the command line.
SHOW_STACK_TRACE_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: This option indicates if a strack trace should be shown for an error ExitStatus.
showHelp() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Output the help text to the console.
showVersion() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: Output version information.

T

toArgument(Option) - Static method in class gov.nist.secauto.metaschema.cli.processor.OptionUtils: Generate the argument text for the given option.
toExitStatus() - Method in exception gov.nist.secauto.metaschema.cli.processor.command.CommandExecutionException: Generate an ExitStatus based on this exception.

U

using(CLIProcessor.CallingContext, CommandLine, ICommandExecutor.ExecutionFunction) - Static method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommandExecutor: Create a new command executor.

V

validateExtraArguments(CLIProcessor.CallingContext, CommandLine) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Validates that the provided extra arguments meet expectations.
validateOptions(CLIProcessor.CallingContext, CommandLine) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand: Validate the options provided on the command line based on what is required for this command.
valueOf(String) - Static method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor: This option indicates if the version information should be shown.

W

withThrowable(Throwable) - Method in class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus
withThrowable(Throwable) - Method in interface gov.nist.secauto.metaschema.cli.processor.ExitStatus: Associate a throwable with the exit status.

A C D E F G H I M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form