Index

C D E F G I L O R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

C

c - Variable in class io.github.mmm.cli.CliMain

CliArgs - Class in io.github.mmm.cli

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.CliArgs

The constructor.

CliArgument - Class in io.github.mmm.cli

A single argument of a main method from a command-line-interface (CLI).

CliArgument(String) - Constructor for class io.github.mmm.cli.CliArgument

The constructor.

CliConsole - Interface in io.github.mmm.cli.io

Interface to give access to output and CliIn.

CliConsoleImpl - Class in io.github.mmm.cli.io.impl

Interface for a console as standard in, out, and err.

CliConsoleImpl() - Constructor for class io.github.mmm.cli.io.impl.CliConsoleImpl

The constructor.

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.

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.

CliInConsole - Class in io.github.mmm.cli.io.impl

Implementation of CliIn that delegates to Console.

CliInConsole(Console) - Constructor for class io.github.mmm.cli.io.impl.CliInConsole

The constructor.

CliInReader - Class in io.github.mmm.cli.io.impl

Implementation of CliInReader to read input from a BufferedReader and write output to a PrintStream.

CliInReader(BufferedReader, PrintStream) - Constructor for class io.github.mmm.cli.io.impl.CliInReader

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

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.

CliOption - Class in io.github.mmm.cli

CliArgument for an option.

CliOption(String, boolean) - Constructor for class io.github.mmm.cli.CliOption

The constructor.

CliOut - Interface in io.github.mmm.cli.io

Interface to log messages and exceptions.

CliOutLogger - Class in io.github.mmm.cli.io.impl

Implementation of CliOut that logs to a given PrintStream.

CliOutLogger(PrintStream, String, Locale, boolean) - Constructor for class io.github.mmm.cli.io.impl.CliOutLogger

The constructor.

CliOutNone - Class in io.github.mmm.cli.io.impl

Implementation of CliOut that does nothing.

CliOutNone() - Constructor for class io.github.mmm.cli.io.impl.CliOutNone

The constructor.

CliShortOption - Class in io.github.mmm.cli

CliOption in short format (e.g.

CliValue - Class in io.github.mmm.cli

A CliArgument that is not a CliOption but a value.

console() - Method in class io.github.mmm.cli.CliMain

createOut(CliLogLevel) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

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.CliArgument

The argument to indicate the end of the options.

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

flush() - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

flush() - Method in class io.github.mmm.cli.io.impl.CliInConsole

flush() - Method in class io.github.mmm.cli.io.impl.CliInReader

G

get() - Method in class io.github.mmm.cli.CliArgument

getDuplicatedOptions() - Method in class io.github.mmm.cli.CliArgs

getFirst() - Method in class io.github.mmm.cli.CliArgs

getLastOption() - Method in class io.github.mmm.cli.CliArgs

getLocale() - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

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

getLogLevel() - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

getNext() - Method in class io.github.mmm.cli.CliArgument

getNextOption() - Method in class io.github.mmm.cli.CliArgument

getNextValue() - Method in class io.github.mmm.cli.CliArgument

getOption(boolean, String...) - Method in class io.github.mmm.cli.CliArgs

getOption(boolean, Collection<String>) - Method in class io.github.mmm.cli.CliArgs

getOption(String) - Method in class io.github.mmm.cli.CliArgs

getOption(String...) - Method in class io.github.mmm.cli.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.CliArgument

getOptionName() - Method in class io.github.mmm.cli.CliLongOption

getOptionName() - Method in class io.github.mmm.cli.CliShortOption

getOptionName() - Method in class io.github.mmm.cli.CliValue

getOriginalArguments() - Method in class io.github.mmm.cli.CliArgs

getOriginalArgumentsAsString() - Method in class io.github.mmm.cli.CliArgs

getOut(CliLogLevel) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

May be overridden to change defaults (e.g.

getOutPrefix(CliLogLevel) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

May be overridden to change style (e.g.

getSize() - Method in class io.github.mmm.cli.CliArgs

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

getStdErr() - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

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

getStdOut() - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

getValue() - Method in class io.github.mmm.cli.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.CliArgument

Like CliArgument.getValue() but returns all the next values.

getVersion() - Method in class io.github.mmm.cli.CliMain

I

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

in() - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

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.io.impl.CliInConsole

The singleton instance.

INSTANCE - Static variable in class io.github.mmm.cli.io.impl.CliOutNone

The singleton instance.

io.github.mmm.cli - module io.github.mmm.cli

Provides the API and implementation to parse the arguments of a main method from a command-line-interface (CLI).

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.exception - package io.github.mmm.cli.exception

Contains common exceptions for CLI.

io.github.mmm.cli.io - package io.github.mmm.cli.io

io.github.mmm.cli.io.impl - package io.github.mmm.cli.io.impl

Contains internal implementations of this module.

isAssignment() - Method in class io.github.mmm.cli.CliOption

isEmpty() - Method in class io.github.mmm.cli.CliArgs

isEndOptions() - Method in class io.github.mmm.cli.CliArgument

isEndOptions() - Method in class io.github.mmm.cli.CliOption

isEndOptions() - Method in class io.github.mmm.cli.CliValue

isLongOption() - Method in class io.github.mmm.cli.CliArgument

isLongOption() - Method in class io.github.mmm.cli.CliLongOption

isLongOption() - Method in class io.github.mmm.cli.CliShortOption

isLongOption() - Method in class io.github.mmm.cli.CliValue

isOption() - Method in class io.github.mmm.cli.CliArgument

isOption() - Method in class io.github.mmm.cli.CliOption

isOption() - Method in class io.github.mmm.cli.CliValue

isPrintStacktrace(CliLogLevel) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

isShortOption() - Method in class io.github.mmm.cli.CliArgument

isShortOption() - Method in class io.github.mmm.cli.CliLongOption

isShortOption() - Method in class io.github.mmm.cli.CliShortOption

isShortOption() - Method in class io.github.mmm.cli.CliValue

isSuppressed() - Method in interface io.github.mmm.cli.io.CliOut

isSuppressed() - Method in class io.github.mmm.cli.io.impl.CliOutLogger

isSuppressed() - Method in class io.github.mmm.cli.io.impl.CliOutNone

isValue() - Method in class io.github.mmm.cli.CliArgument

isValue() - Method in class io.github.mmm.cli.CliOption

isValue() - Method in class io.github.mmm.cli.CliValue

L

log(Object...) - Method in interface io.github.mmm.cli.io.CliOut

log(Object...) - Method in class io.github.mmm.cli.io.impl.CliOutLogger

log(Object...) - Method in class io.github.mmm.cli.io.impl.CliOutNone

log(String) - Method in interface io.github.mmm.cli.io.CliOut

log(String) - Method in class io.github.mmm.cli.io.impl.CliOutLogger

log(String) - Method in class io.github.mmm.cli.io.impl.CliOutNone

log(String, Throwable) - Method in interface io.github.mmm.cli.io.CliOut

log(String, Throwable) - Method in class io.github.mmm.cli.io.impl.CliOutLogger

log(String, Throwable) - Method in class io.github.mmm.cli.io.impl.CliOutNone

log(Throwable) - Method in interface io.github.mmm.cli.io.CliOut

log(Throwable) - Method in class io.github.mmm.cli.io.impl.CliOutLogger

log(Throwable) - Method in class io.github.mmm.cli.io.impl.CliOutNone

logFormat(String, Object...) - Method in interface io.github.mmm.cli.io.CliOut

Like CliOut.log(String) but with dynamic arguments.

logFormat(String, Object...) - Method in class io.github.mmm.cli.io.impl.CliOutLogger

logFormat(String, Object...) - Method in class io.github.mmm.cli.io.impl.CliOutNone

O

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

out(CliLogLevel) - Method in interface io.github.mmm.cli.io.CliConsole

out(CliLogLevel) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

R

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

readLine(String, Object...) - Method in interface io.github.mmm.cli.io.CliIn

readLine(String, Object...) - Method in class io.github.mmm.cli.io.impl.CliInConsole

readLine(String, Object...) - Method in class io.github.mmm.cli.io.impl.CliInReader

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

readPassword(String, Object...) - Method in interface io.github.mmm.cli.io.CliIn

readPassword(String, Object...) - Method in class io.github.mmm.cli.io.impl.CliInConsole

readPassword(String, Object...) - Method in class io.github.mmm.cli.io.impl.CliInReader

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(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.

S

setIn(CliIn) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

setIn(BufferedReader) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

setLocale(Locale) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

setLogLevel(CliLogLevel) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

setStdErr(PrintStream) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

setStdOut(PrintStream) - Method in class io.github.mmm.cli.io.impl.CliConsoleImpl

T

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

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

V

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.io.CliLogLevel

Returns an array containing the constants of this enum type, in the order they are declared.

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.

C D E F G I L O R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form