Index (Metaschema CLI Framework 1.0.0-M1 API)

A B C D E F G H I M N O P Q R S T U V W
All Classes All Packages

A

AbstractCommandExecutor - Class in gov.nist.secauto.metaschema.cli.processor.command
AbstractCommandExecutor(CLIProcessor.CallingContext, CommandLine) - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor
AbstractExitStatus - Class in gov.nist.secauto.metaschema.cli.processor
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
AbstractParentCommand(boolean) - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
AbstractTerminalCommand - Class in gov.nist.secauto.metaschema.cli.processor.command
AbstractTerminalCommand() - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand
addCommandHandler(ICommand) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
addCommandHandler(ICommand) - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand

B

BUILD_TIMESTAMP - Static variable in class gov.nist.secauto.metaschema.cli.processor.Version
buildHelpCliSyntax() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Get the CLI syntax.
buildHelpHeader() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext: Callback for providing a help header.

C

CallingContext(List<String>) - Constructor for class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
CLIProcessor - Class in gov.nist.secauto.metaschema.cli.processor
CLIProcessor(String) - Constructor for class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
CLIProcessor(String, List<IVersionInfo>) - Constructor for class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
CLIProcessor.CallingContext - Class in gov.nist.secauto.metaschema.cli.processor
CommandService - Class in gov.nist.secauto.metaschema.cli.processor.command
CommandService() - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.CommandService
COMMIT - Static variable in class gov.nist.secauto.metaschema.cli.processor.Version

D

DefaultExtraArgument - Class in gov.nist.secauto.metaschema.cli.processor.command
DefaultExtraArgument(String, boolean) - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.DefaultExtraArgument
DefaultExtraArgument(String, boolean, int) - Constructor for class gov.nist.secauto.metaschema.cli.processor.command.DefaultExtraArgument

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(CLIProcessor.CallingContext, CommandLine) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommandExecutor.ExecutionFunction
executeCommand(CLIProcessor.CallingContext, CommandLine) - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
exit() - Method in enum gov.nist.secauto.metaschema.cli.processor.ExitCode: Exit without a message.
ExitCode - Enum in gov.nist.secauto.metaschema.cli.processor
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
ExtraArgument - Interface in gov.nist.secauto.metaschema.cli.processor.command

F

FAIL - 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
generateExtraInfo(PrintStream) - Method in class gov.nist.secauto.metaschema.cli.processor.Version
generateExtraInfo(PrintStream) - Method in interface gov.nist.secauto.metaschema.cli.processor.VersionInfo
generateMessage(boolean) - Method in class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus
generateMessage(boolean) - Method in interface gov.nist.secauto.metaschema.cli.processor.ExitStatus: Process the exit status.
getBuildTime() - Method in class gov.nist.secauto.metaschema.cli.processor.Version
getBuildTime() - Method in interface gov.nist.secauto.metaschema.cli.processor.VersionInfo
getCallingContext() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor
getCommand() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor
getCommandLine() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractCommandExecutor
getCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.command.CommandService
getCommit() - Method in class gov.nist.secauto.metaschema.cli.processor.Version
getCommit() - Method in interface gov.nist.secauto.metaschema.cli.processor.VersionInfo
getDescription() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand
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.
getExtraArgs() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
getExtraArguments() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand
getInstance() - Static method in class gov.nist.secauto.metaschema.cli.processor.command.CommandService: Get the singleton instance of the function service.
getMessage() - Method in class gov.nist.secauto.metaschema.cli.processor.AbstractExitStatus: Get the associated message.
getMessage() - Method in class gov.nist.secauto.metaschema.cli.processor.MessageExitStatus
getMessage() - Method in class gov.nist.secauto.metaschema.cli.processor.NonMessageExitStatus
getName() - Method in class gov.nist.secauto.metaschema.cli.processor.command.DefaultExtraArgument
getName() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument
getName() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand
getNumber() - Method in class gov.nist.secauto.metaschema.cli.processor.command.DefaultExtraArgument
getNumber() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument: The allowed 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.
getOptionsList() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
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
getSubCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
getSubCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand
getSubCommands() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand
getTargetCommand() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
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
getTopLevelCommands() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
getVersion() - Method in class gov.nist.secauto.metaschema.cli.processor.Version
getVersion() - Method in interface gov.nist.secauto.metaschema.cli.processor.VersionInfo
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

H

handleInvalidCommand(String) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
handleQuiet() - Static method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
HELP_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor

I

ICommand - Interface in gov.nist.secauto.metaschema.cli.processor.command
ICommandExecutor - Interface in gov.nist.secauto.metaschema.cli.processor.command
ICommandExecutor.ExecutionFunction - Interface in gov.nist.secauto.metaschema.cli.processor.command
INVALID_ARGUMENTS - gov.nist.secauto.metaschema.cli.processor.ExitCode: The provided argument information for a command fails to match argument use requirements.
INVALID_COMMAND - gov.nist.secauto.metaschema.cli.processor.ExitCode: A command was requested by name that doesn't exist or required arguments are missing.
INVALID_TARGET - gov.nist.secauto.metaschema.cli.processor.ExitCode: The target argument was not found or invalid.
InvalidArgumentException - Exception in gov.nist.secauto.metaschema.cli.processor
InvalidArgumentException(String) - Constructor for exception gov.nist.secauto.metaschema.cli.processor.InvalidArgumentException: Generate a new exception.
invokeCommand(CommandLine) - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
IO_ERROR - gov.nist.secauto.metaschema.cli.processor.ExitCode: An error occurred while reading or writing.
isRequired() - Method in class gov.nist.secauto.metaschema.cli.processor.command.DefaultExtraArgument
isRequired() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ExtraArgument
isSubCommandRequired() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractParentCommand
isSubCommandRequired() - Method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand
isSubCommandRequired() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand

M

main(String...) - Static method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
MessageExitStatus - Class in gov.nist.secauto.metaschema.cli.processor
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
NO_COLOR_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
NonMessageExitStatus - Class in gov.nist.secauto.metaschema.cli.processor

O

OK - gov.nist.secauto.metaschema.cli.processor.ExitCode: The command executed without issue.
OPTIONS - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
OptionUtils - Class in gov.nist.secauto.metaschema.cli.processor

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
PROCESSING_ERROR - gov.nist.secauto.metaschema.cli.processor.ExitCode: Handled errors that occur during command execution.

Q

QUIET_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor

R

requiredExtraArgumentsCount() - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand
resolvePathAgainstCWD(Path) - Static method in class gov.nist.secauto.metaschema.cli.processor.command.AbstractTerminalCommand
RUNTIME_ERROR - 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
showHelp() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext
showVersion() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor

T

toArgument(Option) - Static method in class gov.nist.secauto.metaschema.cli.processor.OptionUtils
toOptions() - Method in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor.CallingContext

U

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

V

validateOptions(CLIProcessor.CallingContext, CommandLine) - Method in interface gov.nist.secauto.metaschema.cli.processor.command.ICommand
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 - Class in gov.nist.secauto.metaschema.cli.processor
Version() - Constructor for class gov.nist.secauto.metaschema.cli.processor.Version
VERSION - Static variable in class gov.nist.secauto.metaschema.cli.processor.Version
VERSION_OPTION - Static variable in class gov.nist.secauto.metaschema.cli.processor.CLIProcessor
VersionInfo - Interface in gov.nist.secauto.metaschema.cli.processor

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 B C D E F G H I M N O P Q R S T U V W
All Classes All Packages