Index (JavaDocs for mmm-cli 0.9.2)

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

A

AbstractCliCommandContainer - Interface in io.github.mmm.cli.container: A group of CliCommandContainers that allows to combine the help of multiple commands.
AbstractCliPropertiesContainer - Interface in io.github.mmm.cli.container: Container with the metadata of a Property from a CliCommand.
add(CliCommand) - Method in interface io.github.mmm.cli.CliAddCommand
add(CliCommand...) - Method in interface io.github.mmm.cli.CliAddCommand
add(Class<? extends CliCommand>) - Method in interface io.github.mmm.cli.CliAddCommand
add(Class<? extends CliCommand>...) - Method in interface io.github.mmm.cli.CliAddCommand
addCommands() - Method in class io.github.mmm.cli.CliMain: Adds the CliCommands for this program.
ALIAS_WILDCARD - Static variable in interface io.github.mmm.cli.command.CliCommand: PropertyAlias to signal that any value including an unmatched option (value starting with a hyphen like "-value") is allowed here.
Arguments() - Method in interface io.github.mmm.cli.command.CliCommandAutoComplete

C

CliAddCommand - Interface in io.github.mmm.cli: Interface to add CliCommands.
CliArgs - Class in io.github.mmm.cli.arg: A simple wrapper for the arguments of a main method from a command-line-interface (CLI).
CliArgs(String...) - Constructor for class io.github.mmm.cli.arg.CliArgs: The constructor.
CliArgument - Class in io.github.mmm.cli.arg: A single argument of a main method from a command-line-interface (CLI).
CliArgument(String) - Constructor for class io.github.mmm.cli.arg.CliArgument: The constructor.
CliArgumentMandatoryException - Exception in io.github.mmm.cli.exception: Thrown if a mandatory CliValue is missing.
CliArgumentMandatoryException(String) - Constructor for exception io.github.mmm.cli.exception.CliArgumentMandatoryException: The constructor.
CliBundle - Class in io.github.mmm.cli: Simple wrapper for ResourceBundle to circumvent flaws and bugs in JDK.
CliBundle(String, CliConsole) - Constructor for class io.github.mmm.cli.CliBundle: The constructor.
CliCommand - Interface in io.github.mmm.cli.command: Interface for a single command of a command-line-interface (CLI).
CliCommandAutoComplete - Interface in io.github.mmm.cli.command: CliCommand for auto-completion of the CLI.
CliCommandContainer - Interface in io.github.mmm.cli.container: Container for a command with its properties.
CliCommandContainerGroup - Interface in io.github.mmm.cli.container: A group of CliCommandContainers that allows to combine the help of multiple commands.
CliCommandHelp - Interface in io.github.mmm.cli.command: CliCommand to print the help of the program.
CliCommandVersion - Interface in io.github.mmm.cli.command: CliCommand to print the version of the program.
CliConsole - Interface in io.github.mmm.cli.io: Interface to give access to output and CliIn.
CliContainer - Interface in io.github.mmm.cli.container: A container for the entire CLI meta-data.
CliDuplicateOptionAliasException - Exception in io.github.mmm.cli.exception: CliException thrown if two synonymous CliOptions have been specified.
CliDuplicateOptionAliasException(CliOption, CliOption) - Constructor for exception io.github.mmm.cli.exception.CliDuplicateOptionAliasException: The constructor.
CliDuplicateOptionsException - Exception in io.github.mmm.cli.exception: CliException thrown if two one or multiple CliOptions have occurred multiple times.
CliDuplicateOptionsException(Set<String>) - Constructor for exception io.github.mmm.cli.exception.CliDuplicateOptionsException: The constructor.
CliException - Exception in io.github.mmm.cli.exception: Abstract base class for a RuntimeException thrown for invalid CliArguments.
CliException(Localizable) - Constructor for exception io.github.mmm.cli.exception.CliException: The constructor.
CliException(Localizable, Throwable) - Constructor for exception io.github.mmm.cli.exception.CliException: The constructor.
CliException(String) - Constructor for exception io.github.mmm.cli.exception.CliException: The constructor.
CliException(String, Throwable) - Constructor for exception io.github.mmm.cli.exception.CliException: The constructor.
CliIn - Interface in io.github.mmm.cli.io: Interface to read input.
CliInvalidUsageException - Exception in io.github.mmm.cli.exception: CliException thrown if the CliArgs are invalid as they did not match any CliCommand.
CliInvalidUsageException(CliArgs) - Constructor for exception io.github.mmm.cli.exception.CliInvalidUsageException: The constructor.
CliLogLevel - Enum in io.github.mmm.cli.io: Enum for the levels to log to a CliConsoleImpl.
CliLongOption - Class in io.github.mmm.cli.arg: CliOption in long format (e.g.
CliMain - Class in io.github.mmm.cli: This is the abstract base class for a main-program.
CliMain() - Constructor for class io.github.mmm.cli.CliMain: The constructor.
CliMain(CliConsole) - Constructor for class io.github.mmm.cli.CliMain: The constructor.
CliNoArgumentsException - Exception in io.github.mmm.cli.exception: CliException thrown if the CliArgs are empty did not match any CliCommand.
CliNoArgumentsException() - Constructor for exception io.github.mmm.cli.exception.CliNoArgumentsException: The constructor.
CliOption - Class in io.github.mmm.cli.arg: CliArgument for an option.
CliOption(String, boolean) - Constructor for class io.github.mmm.cli.arg.CliOption: The constructor.
CliOut - Interface in io.github.mmm.cli.io: Interface to log messages and exceptions.
CliPropertyContainer - Interface in io.github.mmm.cli.container: Container with the metadata of a Property from a CliCommand.
CliShortOption - Class in io.github.mmm.cli.arg: CliOption in short format (e.g.
CliValue - Class in io.github.mmm.cli.arg: A CliArgument that is not a CliOption but a value.
CliValueType - Enum in io.github.mmm.cli.arg: Enum with the available options of a CliValue type.
Complete() - Method in interface io.github.mmm.cli.command.CliCommandAutoComplete
console - Variable in class io.github.mmm.cli.CliMain
console() - Method in class io.github.mmm.cli.CliMain

D

debug() - Method in interface io.github.mmm.cli.io.CliConsole
DEBUG - Enum constant in enum io.github.mmm.cli.io.CliLogLevel: Debug information with details for developers and to get more details in case of problems or errors.

E

END_OPTIONS - Static variable in class io.github.mmm.cli.arg.CliArgument: The argument to indicate the end of the options.
errArgumentMandatory(String) - Method in class io.github.mmm.cli.NlsBundleCli
errDuplicateOptions(Object) - Method in class io.github.mmm.cli.NlsBundleCli
errInvalidArguments(Object) - Method in class io.github.mmm.cli.NlsBundleCli
errNoArguments() - Method in class io.github.mmm.cli.NlsBundleCli
error() - Method in interface io.github.mmm.cli.io.CliConsole
error(CliArgument) - Method in class io.github.mmm.cli.CliMain
error(Throwable) - Method in class io.github.mmm.cli.CliMain
ERROR - Enum constant in enum io.github.mmm.cli.io.CliLogLevel: Error information if something went wrong and processing typically failed and has to be aborted.

F

flush() - Method in interface io.github.mmm.cli.io.CliConsole
flush() - Method in interface io.github.mmm.cli.io.CliIn

G

get() - Method in class io.github.mmm.cli.arg.CliArgument
get(String) - Method in class io.github.mmm.cli.CliBundle
get(String, String) - Method in class io.github.mmm.cli.CliBundle
getAliases() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
getArgs() - Method in exception io.github.mmm.cli.exception.CliInvalidUsageException
getCommand() - Method in interface io.github.mmm.cli.container.CliCommandContainer
getCommand(int) - Method in interface io.github.mmm.cli.container.CliCommandContainerGroup
getCommand(CliCommand) - Method in interface io.github.mmm.cli.container.AbstractCliCommandContainer
getCommandCount() - Method in interface io.github.mmm.cli.container.CliCommandContainerGroup
getContainer() - Method in class io.github.mmm.cli.CliMain
getDuplicatedOptions() - Method in class io.github.mmm.cli.arg.CliArgs
getFirst() - Method in class io.github.mmm.cli.arg.CliArgs
getGroup(String) - Method in interface io.github.mmm.cli.container.CliContainer
getGroups() - Method in interface io.github.mmm.cli.container.CliContainer
getHelp() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
getIndex() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
getLastOption() - Method in class io.github.mmm.cli.arg.CliArgs
getLocale() - Method in interface io.github.mmm.cli.io.CliConsole
getLogLevel() - Method in interface io.github.mmm.cli.io.CliConsole
getName() - Method in interface io.github.mmm.cli.container.CliCommandContainerGroup
getNext() - Method in class io.github.mmm.cli.arg.CliArgument
getNextOption() - Method in class io.github.mmm.cli.arg.CliArgument
getNextValue() - Method in class io.github.mmm.cli.arg.CliArgument
getOption(boolean, String...) - Method in class io.github.mmm.cli.arg.CliArgs
getOption(boolean, Collection<String>) - Method in class io.github.mmm.cli.arg.CliArgs
getOption(String) - Method in class io.github.mmm.cli.arg.CliArgs
getOption(String...) - Method in class io.github.mmm.cli.arg.CliArgs
getOption1() - Method in exception io.github.mmm.cli.exception.CliDuplicateOptionAliasException
getOption2() - Method in exception io.github.mmm.cli.exception.CliDuplicateOptionAliasException
getOptionName() - Method in class io.github.mmm.cli.arg.CliArgument
getOptionName() - Method in class io.github.mmm.cli.arg.CliLongOption
getOptionName() - Method in class io.github.mmm.cli.arg.CliShortOption
getOptionName() - Method in class io.github.mmm.cli.arg.CliValue
getOptions() - Method in exception io.github.mmm.cli.exception.CliDuplicateOptionsException
getOriginalArguments() - Method in class io.github.mmm.cli.arg.CliArgs
getOriginalArgumentsAsString() - Method in class io.github.mmm.cli.arg.CliArgs
getProgramName() - Method in class io.github.mmm.cli.CliMain
getProperties() - Method in interface io.github.mmm.cli.container.AbstractCliPropertiesContainer
getProperty(String) - Method in interface io.github.mmm.cli.container.CliCommandContainer
getPropertyName() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
getSize() - Method in class io.github.mmm.cli.arg.CliArgs
getStdErr() - Method in interface io.github.mmm.cli.io.CliConsole
getStdOut() - Method in interface io.github.mmm.cli.io.CliConsole
getSyntax() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
getUsage() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
getValue() - Method in class io.github.mmm.cli.arg.CliArgument: If this is a CliOption followed by a CliValue, this method will return that value (e.g.
getValues() - Method in class io.github.mmm.cli.arg.CliArgument: Like CliArgument.getValue() but returns all the next values.
getValueType() - Method in class io.github.mmm.cli.arg.CliArgument
getValueType() - Method in class io.github.mmm.cli.arg.CliOption
getValueType() - Method in class io.github.mmm.cli.arg.CliValue
getVersion() - Method in class io.github.mmm.cli.CliMain
group() - Method in class io.github.mmm.cli.CliMain
group(String) - Method in class io.github.mmm.cli.CliMain

H

hasIndex() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
Help() - Method in interface io.github.mmm.cli.command.CliCommandHelp
hideFromHelp() - Method in interface io.github.mmm.cli.command.CliCommand
hideFromHelp() - Method in interface io.github.mmm.cli.command.CliCommandAutoComplete

I

in() - Method in interface io.github.mmm.cli.io.CliConsole
includes(CliLogLevel) - Method in enum io.github.mmm.cli.io.CliLogLevel
info() - Method in interface io.github.mmm.cli.io.CliConsole
INFO - Enum constant in enum io.github.mmm.cli.io.CliLogLevel: General information for end-users to get helpful feedback about what is going on.
INSTANCE - Static variable in class io.github.mmm.cli.NlsBundleCli
io.github.mmm.cli - module io.github.mmm.cli: Provides the infrastructure to implement a command-line-interface (CLI) to parse, validate and bind the arguments of a main method and execute the selected command.
io.github.mmm.cli - package io.github.mmm.cli: Contains the API and implementation to parse the arguments of a main method from a command-line-interface (CLI).
io.github.mmm.cli.arg - package io.github.mmm.cli.arg: Contains CLI arguments as options and values.
io.github.mmm.cli.command - package io.github.mmm.cli.command: Contains CliCommand interface with default commands for help and version.
io.github.mmm.cli.container - package io.github.mmm.cli.container
io.github.mmm.cli.exception - package io.github.mmm.cli.exception: Contains common exceptions for CLI.
io.github.mmm.cli.io - package io.github.mmm.cli.io
isAssignment() - Method in class io.github.mmm.cli.arg.CliOption
isEmpty() - Method in class io.github.mmm.cli.arg.CliArgs
isEndOptions() - Method in class io.github.mmm.cli.arg.CliArgument
isEndOptions() - Method in class io.github.mmm.cli.arg.CliOption
isFlag() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
isKeyword() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
isLongOption() - Method in class io.github.mmm.cli.arg.CliArgument
isLongOption() - Method in class io.github.mmm.cli.arg.CliLongOption
isLongOption() - Method in class io.github.mmm.cli.arg.CliShortOption
isLongOption() - Method in class io.github.mmm.cli.arg.CliValue
isMandatory() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
isOption() - Method in class io.github.mmm.cli.arg.CliArgument
isOption() - Method in class io.github.mmm.cli.arg.CliOption
isOption() - Method in class io.github.mmm.cli.arg.CliValue
isOption() - Method in enum io.github.mmm.cli.arg.CliValueType
isOption() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
isShortOption() - Method in class io.github.mmm.cli.arg.CliArgument
isShortOption() - Method in class io.github.mmm.cli.arg.CliLongOption
isShortOption() - Method in class io.github.mmm.cli.arg.CliShortOption
isShortOption() - Method in class io.github.mmm.cli.arg.CliValue
isSuppressed() - Method in interface io.github.mmm.cli.io.CliOut
isTolerateDuplicateOptions() - Method in class io.github.mmm.cli.CliMain: Typically a program shall provide multiple values for a CliOption by providing them as multiple CliValues after the CliOption (e.g.
isValue() - Method in class io.github.mmm.cli.arg.CliArgument
isValue() - Method in class io.github.mmm.cli.arg.CliOption
isValue() - Method in class io.github.mmm.cli.arg.CliValue
isValue() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
isVararg() - Method in interface io.github.mmm.cli.container.CliPropertyContainer
isWildcard() - Method in interface io.github.mmm.cli.container.CliPropertyContainer

L

log(Object...) - Method in interface io.github.mmm.cli.io.CliOut
log(String) - Method in interface io.github.mmm.cli.io.CliOut
log(String, Throwable) - Method in interface io.github.mmm.cli.io.CliOut
log(Throwable) - Method in interface io.github.mmm.cli.io.CliOut
logFormat(String, Object...) - Method in interface io.github.mmm.cli.io.CliOut: Like log(String) but with dynamic arguments.

M

msgJavaSystemProperty(String) - Method in class io.github.mmm.cli.NlsBundleCli

N

NlsBundleCli - Class in io.github.mmm.cli: NlsBundle for command-line-interface (CLI).
NlsBundleCli() - Constructor for class io.github.mmm.cli.NlsBundleCli

O

of(CliCommand, CliConsole) - Static method in class io.github.mmm.cli.CliBundle
of(Class<? extends CliCommand>, CliConsole) - Static method in class io.github.mmm.cli.CliBundle
OPTION_ASSIGNMENT - Enum constant in enum io.github.mmm.cli.arg.CliValueType: An option assignment (e.g.
OPTION_VALUE - Enum constant in enum io.github.mmm.cli.arg.CliValueType: An option value (e.g.
out() - Method in interface io.github.mmm.cli.io.CliConsole
out(CliLogLevel) - Method in interface io.github.mmm.cli.io.CliConsole

P

printJvmOptions(CliOut, CliBundle, CliConsole) - Method in interface io.github.mmm.cli.command.CliCommandHelp

R

readLine() - Method in interface io.github.mmm.cli.io.CliIn
readLine(String, Object...) - Method in interface io.github.mmm.cli.io.CliIn
readPassword() - Method in interface io.github.mmm.cli.io.CliIn
readPassword(String, Object...) - Method in interface io.github.mmm.cli.io.CliIn
run(CliArgs) - Method in class io.github.mmm.cli.CliMain: Has to be implemented to handle that given CliArgs and do the program logic.
run(CliMain) - Method in interface io.github.mmm.cli.command.CliCommand: Executes this CliCommand.
run(CliMain) - Method in interface io.github.mmm.cli.command.CliCommandAutoComplete
run(CliMain) - Method in interface io.github.mmm.cli.command.CliCommandHelp
run(CliMain) - Method in interface io.github.mmm.cli.command.CliCommandVersion
run(String...) - Method in class io.github.mmm.cli.CliMain: This method parses the given args as CliArgs and delegates to CliMain.run(CliArgs).
runAndExit(String...) - Method in class io.github.mmm.cli.CliMain: This method delegates to CliMain.run(String...) and then calls System.exit(int) with the returned exit code.

T

toString() - Method in class io.github.mmm.cli.arg.CliArgs
toString() - Method in class io.github.mmm.cli.arg.CliArgument

V

VALUE_BEFORE_OPTION - Enum constant in enum io.github.mmm.cli.arg.CliValueType: A regular value before the first option (e.g.
VALUE_CONTINUED - Enum constant in enum io.github.mmm.cli.arg.CliValueType: A continued value after an CliValueType.OPTION_VALUE (e.g.
VALUE_END_OPTION - Enum constant in enum io.github.mmm.cli.arg.CliValueType: A regular value after the options have explicitly ended (e.g.
valueOf(String) - Static method in enum io.github.mmm.cli.arg.CliValueType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.github.mmm.cli.io.CliLogLevel: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.mmm.cli.arg.CliValueType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.github.mmm.cli.io.CliLogLevel: Returns an array containing the constants of this enum type, in the order they are declared.
Version() - Method in interface io.github.mmm.cli.command.CliCommandVersion

W

warning() - Method in interface io.github.mmm.cli.io.CliConsole
WARNING - Enum constant in enum io.github.mmm.cli.io.CliLogLevel: Warning information if something is not as expected but does not prevent further processing.

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