Index (Terminal Utils 4.1.0 API)

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

A

add(A) - Method in interface net.morimekta.terminal.args.ArgParser.Builder: An argument
add(String...) - Method in class net.morimekta.terminal.LineBuffer: Add new lines to the end of the buffer, and print them out.
add(Collection<String>) - Method in class net.morimekta.terminal.LineBuffer: Add new lines to the end of the buffer, and print them out.
add(Arg.Builder<A>) - Method in interface net.morimekta.terminal.args.ArgParser.Builder: Add an argument builder.
add(SubCommand.Builder<? extends SubCommandDef>) - Method in interface net.morimekta.terminal.args.SubCommandSet.Builder
add(SubCommand<? extends SubCommandDef>) - Method in interface net.morimekta.terminal.args.SubCommandSet.Builder
addTask(String, ProgressManager.ProgressAsyncHandler<T>) - Method in class net.morimekta.terminal.progress.ProgressManager: Add a task to be done while showing progress.
addTask(String, ProgressManager.ProgressHandler<T>) - Method in class net.morimekta.terminal.progress.ProgressManager: Add a task to be done while showing progress.
alias(String...) - Method in interface net.morimekta.terminal.args.SubCommand.Builder
andApply(Consumer<T>) - Method in interface net.morimekta.terminal.args.ValueParser: Make a string consumer to typed value consumer out of the converter.
andPut(ValueParser.TypedPutter<T>) - Method in interface net.morimekta.terminal.args.ValueParser: Make a property putter that calls a typed putter with the parsed value.
andPutAs(ValueParser.TypedPutter<T>, String) - Method in interface net.morimekta.terminal.args.ValueParser: Make a consumer that puts a specific value with the typed putter.
apply(List<String>) - Method in interface net.morimekta.terminal.args.Arg: Try to apply to the argument.
applyShort(String, List<String>) - Method in interface net.morimekta.terminal.args.Option: When handling a list of short options.
Arg - Interface in net.morimekta.terminal.args: Base interface for all arguments and options.
Arg.Builder<A extends Arg> - Interface in net.morimekta.terminal.args: Builder for making an argument instance.
ArgException - Exception in net.morimekta.terminal.args: Argument exception.
ArgException(String, Object...) - Constructor for exception net.morimekta.terminal.args.ArgException
ArgException(Throwable, String, Object...) - Constructor for exception net.morimekta.terminal.args.ArgException: Deprecated, for removal: This API element is subject to removal in a future version.
Use ArgException(String, Object...) instead.
ArgException(ArgParser, String, Object...) - Constructor for exception net.morimekta.terminal.args.ArgException
ArgException(ArgParser, Throwable, String, Object...) - Constructor for exception net.morimekta.terminal.args.ArgException: Deprecated, for removal: This API element is subject to removal in a future version.
Use ArgException(ArgParser, String, Object...) instead.
argHelp(ArgParser) - Static method in interface net.morimekta.terminal.args.ArgHelp
ArgHelp - Interface in net.morimekta.terminal.args: Helper class to display help and usage for a program or sub-command.
ArgHelp.Builder - Interface in net.morimekta.terminal.args: Builder for customizing printed help output.
argParser(String, String, String) - Static method in interface net.morimekta.terminal.args.ArgParser
ArgParser - Interface in net.morimekta.terminal.args
ArgParser.Builder - Interface in net.morimekta.terminal.args: Builder for an argument parser.
ArgParserBuilder - Interface in net.morimekta.terminal.args: Base interface for building an argument parser.
argument(String, String, Consumer<String>) - Static method in interface net.morimekta.terminal.args.Argument
Argument - Interface in net.morimekta.terminal.args
Argument.Builder - Interface in net.morimekta.terminal.args
ASCII - net.morimekta.terminal.progress.DefaultSpinners: Simple ASCII spinner using '|', '/', '-', '\'.
atComplete(Duration, int) - Method in enum net.morimekta.terminal.progress.DefaultSpinners
atComplete(Duration, int) - Method in interface net.morimekta.terminal.progress.Spinner: Generate a progress line that can contain a progress bar, percentage progress and a spinner for a completed progress.
atProgress(double, int, Duration, int) - Method in enum net.morimekta.terminal.progress.DefaultSpinners
atProgress(double, int, Duration, int) - Method in interface net.morimekta.terminal.progress.Spinner: Generate a progress line that can contain a progress bar, percentage progress and a spinner as printed during processing, including not started yet.
atStopped(double, String, int) - Method in enum net.morimekta.terminal.progress.DefaultSpinners
atStopped(double, String, int) - Method in interface net.morimekta.terminal.progress.Spinner: Generate a progress line that can contain a progress bar, percentage progress and a spinner for stopped progress with a message.

B

BLOCKS - net.morimekta.terminal.progress.DefaultSpinners: Using a block char that bounces up and down to show progress.
build() - Method in interface net.morimekta.terminal.args.Arg.Builder
build() - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
build() - Method in interface net.morimekta.terminal.args.ArgParserBuilder
build() - Method in interface net.morimekta.terminal.args.SubCommand.Builder

C

call(E, LinePrinter) - Method in interface net.morimekta.terminal.input.InputSelection.Action: Call the command with the given entry.
clear() - Method in class net.morimekta.terminal.LineBuffer: Clear the entire buffer, and the terminal area it represents.
clearLast(int) - Method in class net.morimekta.terminal.LineBuffer: Clear the last N lines, and move the cursor to the end of the last remaining line.
close() - Method in class net.morimekta.terminal.progress.ProgressLine
close() - Method in class net.morimekta.terminal.progress.ProgressManager: Close the progress and all tasks associated with it.
close() - Method in class net.morimekta.terminal.Terminal
Command(char, String, InputSelection.Action<E>) - Constructor for class net.morimekta.terminal.input.InputSelection.Command
Command(char, String, InputSelection.Action<E>, boolean) - Constructor for class net.morimekta.terminal.input.InputSelection.Command
Command(Char, String, InputSelection.Action<E>) - Constructor for class net.morimekta.terminal.input.InputSelection.Command
Command(Char, String, InputSelection.Action<E>, boolean) - Constructor for class net.morimekta.terminal.input.InputSelection.Command
complete(String, LinePrinter) - Method in interface net.morimekta.terminal.input.InputLine.TabCompletion: Try to complete the given string.
confirm(String) - Method in class net.morimekta.terminal.Terminal: Make a user confirmation.
confirm(String, boolean) - Method in class net.morimekta.terminal.Terminal: Make a user confirmation.
count() - Method in class net.morimekta.terminal.LineBuffer

D

dbl() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a double parser.
dbl(Consumer<Double>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a 64-bit integer parsing consumer.
defaultCommand(String) - Method in interface net.morimekta.terminal.args.SubCommandSet.Builder
defaultOff() - Method in interface net.morimekta.terminal.args.Flag.Builder
defaultOn() - Method in interface net.morimekta.terminal.args.Flag.Builder
DefaultSpinners - Enum in net.morimekta.terminal.progress: Which spinner to show.
defaultValue(boolean) - Method in interface net.morimekta.terminal.args.Flag.Builder
defaultValue(Object) - Method in interface net.morimekta.terminal.args.Argument.Builder
defaultValue(Object) - Method in interface net.morimekta.terminal.args.Option.Builder
dir() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parser that refers to an existing directory.
dir(Consumer<Path>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parsing consumer that refers to an existing directory.
DirParser() - Constructor for class net.morimekta.terminal.args.ValueParser.DirParser
DoubleParser() - Constructor for class net.morimekta.terminal.args.ValueParser.DoubleParser
duration() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a parser that parses a duration.
duration(Consumer<Duration>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a parsing consumer that parses a duration.
DurationParser() - Constructor for class net.morimekta.terminal.args.ValueParser.DurationParser

E

EnumParser(Class<E>) - Constructor for class net.morimekta.terminal.args.ValueParser.EnumParser
EnumParser(Class<E>, EnumSet<E>) - Constructor for class net.morimekta.terminal.args.ValueParser.EnumParser
error(String, Object...) - Method in interface net.morimekta.terminal.LinePrinter: Print an error string message.
executeAbortable(ExecutorService, Runnable) - Method in class net.morimekta.terminal.Terminal: Execute runnable, which may not be interruptable by itself, but listen to terminal input and abort the task if CTRL-C is pressed.
executeAbortable(ExecutorService, Callable<T>) - Method in class net.morimekta.terminal.Terminal: Execute callable, which may not be interruptable by itself, but listen to terminal input and abort the task if CTRL-C is pressed.
EXIT - net.morimekta.terminal.input.InputSelection.Reaction: Exit selection with no value (null).

F

fatal(String, Object...) - Method in interface net.morimekta.terminal.LinePrinter: Print a fatal string message.
file() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parser that refers to an existing file.
file(Consumer<Path>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parsing consumer that refers to an existing file.
FileParser() - Constructor for class net.morimekta.terminal.args.ValueParser.FileParser
finish() - Method in class net.morimekta.terminal.Terminal: Finish the current set of lines and continue below.
flag(String, String, String, Consumer<Boolean>) - Static method in interface net.morimekta.terminal.args.Flag
Flag - Interface in net.morimekta.terminal.args: Similar to Option, but without any value argument.
Flag.Builder - Interface in net.morimekta.terminal.args
flagLong(String, String, Consumer<Boolean>) - Static method in interface net.morimekta.terminal.args.Flag
flagShort(String, String, Consumer<Boolean>) - Static method in interface net.morimekta.terminal.args.Flag
format(String, Object...) - Method in class net.morimekta.terminal.Terminal: Format and print string.
formatln(String, Object...) - Method in interface net.morimekta.terminal.LinePrinter: Format and print a string message.

G

generateArgs(Object) - Method in interface net.morimekta.terminal.args.ArgParser.Builder: Generate arguments to fill in the POJO config object.
getAliases() - Method in interface net.morimekta.terminal.args.SubCommand: Get the list of sub-command aliases.
getArguments() - Method in interface net.morimekta.terminal.args.ArgParser
getAsBoolean() - Method in class net.morimekta.terminal.input.InputConfirmation
getDefaultValue() - Method in interface net.morimekta.terminal.args.Arg: A default value descriptor.
getDescription() - Method in interface net.morimekta.terminal.args.ArgParser: Short description of the program.
getMetaKey() - Method in interface net.morimekta.terminal.args.Property
getMetaVar() - Method in interface net.morimekta.terminal.args.Option: Meta variable to show in usage printout.
getName() - Method in interface net.morimekta.terminal.args.Arg: The argument name.
getName() - Method in interface net.morimekta.terminal.args.SubCommand: The sub-command name.
getNegateName() - Method in interface net.morimekta.terminal.args.Flag: The alternative (negating) long name for the flag.
getOptions() - Method in interface net.morimekta.terminal.args.ArgParser
getOutputStream() - Method in class net.morimekta.terminal.Terminal
getParent() - Method in interface net.morimekta.terminal.args.ArgParser
getParser() - Method in exception net.morimekta.terminal.args.ArgException
getPrefix() - Method in interface net.morimekta.terminal.args.Arg: Prefix part of the usage message.
getProgram() - Method in interface net.morimekta.terminal.args.ArgParser: The name of the program.
getProgress() - Method in class net.morimekta.terminal.progress.Progress
getRatio() - Method in class net.morimekta.terminal.progress.Progress
getShortNames() - Method in interface net.morimekta.terminal.args.Option: Each character of the shortNames string is handled as a short option that is parsed with the -[short] style.
getSingleLineUsage() - Method in interface net.morimekta.terminal.args.Arg: Get the argument's single line usage string.
getSubCommandByName(String) - Method in interface net.morimekta.terminal.args.SubCommandSet
getSubCommands() - Method in interface net.morimekta.terminal.args.SubCommandSet
getSubCommandSet() - Method in interface net.morimekta.terminal.args.ArgParser
getTotal() - Method in class net.morimekta.terminal.progress.Progress
getTTY() - Method in class net.morimekta.terminal.Terminal
getUsage() - Method in interface net.morimekta.terminal.args.Arg: The argument usage description.
getUsage() - Method in interface net.morimekta.terminal.args.SubCommand: The basic usage description.
getVersion() - Method in interface net.morimekta.terminal.args.ArgParser: The program version string.

H

handle(CompletableFuture<T>, Flow.Subscriber<Progress>) - Method in interface net.morimekta.terminal.progress.ProgressManager.ProgressAsyncHandler
handle(Flow.Subscriber<Progress>) - Method in interface net.morimekta.terminal.progress.ProgressManager.ProgressHandler
handleInterrupt(Char) - Method in class net.morimekta.terminal.input.InputConfirmation: Handle user interrupts.
hidden() - Method in interface net.morimekta.terminal.args.Argument.Builder
hidden() - Method in interface net.morimekta.terminal.args.Flag.Builder
hidden() - Method in interface net.morimekta.terminal.args.Option.Builder
hidden() - Method in interface net.morimekta.terminal.args.Property.Builder
hidden() - Method in interface net.morimekta.terminal.args.SubCommand.Builder

I

i32() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a 32-bit integer parser.
i32(Consumer<Integer>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a 32-bit integer parsing consumer.
i64() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a 64-bit integer parser.
i64(Consumer<Long>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a 64-bit integer parsing consumer.
info(String, Object...) - Method in interface net.morimekta.terminal.LinePrinter: Print an info string message.
InputConfirmation - Class in net.morimekta.terminal.input
InputConfirmation(Terminal, String) - Constructor for class net.morimekta.terminal.input.InputConfirmation: Constructor for simple confirmation.
InputConfirmation(Terminal, String, Boolean) - Constructor for class net.morimekta.terminal.input.InputConfirmation: Constructor for complete line-input.
InputLine - Class in net.morimekta.terminal.input: Class that handled reading a line from terminal input with character and line validators, and optional tab completion.
InputLine(Terminal, String) - Constructor for class net.morimekta.terminal.input.InputLine: Constructor for simple line-input.
InputLine(Terminal, String, InputLine.CharValidator, InputLine.LineValidator, InputLine.TabCompletion) - Constructor for class net.morimekta.terminal.input.InputLine: Constructor for complete line-input.
InputLine(Terminal, String, InputLine.CharValidator, InputLine.LineValidator, InputLine.TabCompletion, Pattern) - Constructor for class net.morimekta.terminal.input.InputLine: Constructor for complete line-input.
InputLine.CharValidator - Interface in net.morimekta.terminal.input: Character validator interface.
InputLine.LineValidator - Interface in net.morimekta.terminal.input: Line validator interface.
InputLine.TabCompletion - Interface in net.morimekta.terminal.input: Tab completion interface.
InputPassword - Class in net.morimekta.terminal.input: Class that handled reading a password from terminal.
InputPassword(Terminal, String) - Constructor for class net.morimekta.terminal.input.InputPassword: Constructor for simple line-input.
InputPassword(Terminal, String, String) - Constructor for class net.morimekta.terminal.input.InputPassword: Constructor for complete line-input.
InputSelection<E> - Class in net.morimekta.terminal.input: Tabular selection with simple navigation.
InputSelection(Terminal, String, List<E>, List<InputSelection.Command<E>>, InputSelection.EntryPrinter<E>) - Constructor for class net.morimekta.terminal.input.InputSelection: Create a selection instance.
InputSelection(Terminal, String, List<E>, List<InputSelection.Command<E>>, InputSelection.EntryPrinter<E>, int, int, int) - Constructor for class net.morimekta.terminal.input.InputSelection: Create a selection instance.
InputSelection(Terminal, String, List<E>, List<InputSelection.Command<E>>, InputSelection.EntryPrinter<E>, Clock, int, int, int) - Constructor for class net.morimekta.terminal.input.InputSelection: Create a selection instance.
InputSelection.Action<E> - Interface in net.morimekta.terminal.input: The command action interface.
InputSelection.Command<E> - Class in net.morimekta.terminal.input: Command.
InputSelection.EntryPrinter<E> - Interface in net.morimekta.terminal.input: Interface for the entry printer.
InputSelection.Reaction - Enum in net.morimekta.terminal.input: Command reaction enum.
IntegerParser() - Constructor for class net.morimekta.terminal.args.ValueParser.IntegerParser
isConfirmation(Char) - Method in class net.morimekta.terminal.input.InputConfirmation: If the provided char indicates confirmation.
isDefault(Char) - Method in class net.morimekta.terminal.input.InputConfirmation: Handle backspace.
isDone() - Method in class net.morimekta.terminal.progress.ProgressLine
isHidden() - Method in interface net.morimekta.terminal.args.Arg: True if the argument should be hidden by default.
isHidden() - Method in interface net.morimekta.terminal.args.SubCommand: If the sub-command is hidden by default.
isRejection(Char) - Method in class net.morimekta.terminal.input.InputConfirmation
isRepeated() - Method in interface net.morimekta.terminal.args.Arg: If the argument can be repeated (for arguments means to be multi-valued).
isRequired() - Method in interface net.morimekta.terminal.args.Arg: If the argument is required (must be set).

L

LineBuffer - Class in net.morimekta.terminal: Class that holds a set of lines, that are printed to the terminal, and methods to dynamically update those buffer.
LineBuffer(Terminal) - Constructor for class net.morimekta.terminal.LineBuffer: Create a LineBuffer instance.
LinePrinter - Interface in net.morimekta.terminal: LinePrinter interface.
lines() - Method in class net.morimekta.terminal.LineBuffer
lines() - Method in class net.morimekta.terminal.progress.ProgressManager
LongParser() - Constructor for class net.morimekta.terminal.args.ValueParser.LongParser

M

metaKey(String) - Method in interface net.morimekta.terminal.args.Property.Builder
metaVar(String) - Method in interface net.morimekta.terminal.args.Option.Builder
metaVar(String) - Method in interface net.morimekta.terminal.args.Property.Builder

N

negateName(String) - Method in interface net.morimekta.terminal.args.Flag.Builder
negateShortName(char) - Method in interface net.morimekta.terminal.args.Flag.Builder
net.morimekta.terminal - module net.morimekta.terminal: Package containing utilities for handling advanced terminal I/O.
net.morimekta.terminal - package net.morimekta.terminal
net.morimekta.terminal.args - package net.morimekta.terminal.args
net.morimekta.terminal.input - package net.morimekta.terminal.input
net.morimekta.terminal.progress - package net.morimekta.terminal.progress
newInstance(ArgParser.Builder) - Method in interface net.morimekta.terminal.args.SubCommand: Instantiate the selected commands' implementation.

O

onComplete() - Method in class net.morimekta.terminal.progress.ProgressLine
oneOf(Class<E>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make an enum value parsing consumer.
oneOf(Class<E>, Consumer<E>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parsing consumer that refers to an existing file.
onError(Throwable) - Method in class net.morimekta.terminal.progress.ProgressLine
onNext(Progress) - Method in class net.morimekta.terminal.progress.ProgressLine: Update the progress to reflect the current progress value.
onSubscribe(Flow.Subscription) - Method in class net.morimekta.terminal.progress.ProgressLine
option(String, String, String, Consumer<String>) - Static method in interface net.morimekta.terminal.args.Option
Option - Interface in net.morimekta.terminal.args: Named option that for each invocation takes a single argument value, either the next argument, or from the same argument after a '=' delimiter.
Option.Builder - Interface in net.morimekta.terminal.args
optionalCommand() - Method in interface net.morimekta.terminal.args.SubCommandSet.Builder
optionLong(String, String, Consumer<String>) - Static method in interface net.morimekta.terminal.args.Option
optionShort(String, String, Consumer<String>) - Static method in interface net.morimekta.terminal.args.Option
outputDir() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a parser that refers either to a non-existing entry or an existing directory, but not a file or special device.
outputDir(Consumer<Path>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a parsing consumer that refers either to a non-existing entry or an existing directory, but not a file or special device.
OutputDirParser() - Constructor for class net.morimekta.terminal.args.ValueParser.OutputDirParser
outputFile() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parser that refers either to a non-existing entry or an existing file, but not a directory or special device.
outputFile(Consumer<Path>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a file parsing consumer that refers either to a non-existing entry or an existing file, but not a directory or special device.
OutputFileParser() - Constructor for class net.morimekta.terminal.args.ValueParser.OutputFileParser

P

parse(String) - Method in class net.morimekta.terminal.args.ValueParser.DirParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.DoubleParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.DurationParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.EnumParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.FileParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.IntegerParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.LongParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.OutputDirParser
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.OutputFileParser
parse(String) - Method in interface net.morimekta.terminal.args.ValueParser: Parse the value into a typed instance.
parse(String) - Method in class net.morimekta.terminal.args.ValueParser.PathParser
parse(String...) - Method in interface net.morimekta.terminal.args.ArgParser: Parse arguments from the main method.
parse(String...) - Method in interface net.morimekta.terminal.args.ArgParserBuilder: Build and parse arguments.
parse(List<String>) - Method in interface net.morimekta.terminal.args.ArgParser: Parse arguments from the main method.
parse(List<String>) - Method in interface net.morimekta.terminal.args.ArgParserBuilder: Build and parse arguments.
parserForSubCommand(String) - Method in interface net.morimekta.terminal.args.SubCommandSet
path() - Static method in interface net.morimekta.terminal.args.ValueParser: Make a parser that parses a path.
path(Consumer<Path>) - Static method in interface net.morimekta.terminal.args.ValueParser: Make a parsing consumer that parses a path.
PathParser() - Constructor for class net.morimekta.terminal.args.ValueParser.PathParser
pressToContinue(String) - Method in class net.morimekta.terminal.Terminal: Show a "press any key to continue" message.
print(char) - Method in class net.morimekta.terminal.Terminal
print(E) - Method in interface net.morimekta.terminal.input.InputSelection.EntryPrinter: Print the entry line with default background.
print(E, Color) - Method in interface net.morimekta.terminal.input.InputSelection.EntryPrinter: Print the entry line.
print(String) - Method in class net.morimekta.terminal.Terminal
print(Char) - Method in class net.morimekta.terminal.Terminal
printConfirmation(boolean) - Method in class net.morimekta.terminal.input.InputConfirmation: Print confirmation.
printer() - Method in class net.morimekta.terminal.Terminal: Get a print stream that writes to the terminal according to the output mode of the terminal.
printHelp(PrintStream) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder: Build and print help overview.
printHelp(PrintStream) - Method in interface net.morimekta.terminal.args.ArgHelp: Print the help output for the argument parser, starting with base information about the program, the single line usage, and an overview over options, arguments and sub-commands.
println() - Method in class net.morimekta.terminal.Terminal: Print a newline.
println(String) - Method in interface net.morimekta.terminal.LinePrinter: Print a new line to the terminal.
println(String) - Method in class net.morimekta.terminal.Terminal
printPreamble(PrintStream) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder: Build and print the help preamble.
printPreamble(PrintStream) - Method in interface net.morimekta.terminal.args.ArgHelp: Print the preamble for the help with short options.
printSingleLineUsage(PrintStream) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder: Build and print the single line usage.
printSingleLineUsage(PrintStream) - Method in interface net.morimekta.terminal.args.ArgHelp: Print the single line usage string to print stream.
Progress - Class in net.morimekta.terminal.progress: A progress
Progress(long, long) - Constructor for class net.morimekta.terminal.progress.Progress
ProgressLine - Class in net.morimekta.terminal.progress: Show progress on a single task in how many percent (with spinner and progress-bar).
ProgressLine(TTY, Spinner, String) - Constructor for class net.morimekta.terminal.progress.ProgressLine: Create a progress bar using the default terminal.
ProgressLine(LinePrinter, IntSupplier, Spinner, String) - Constructor for class net.morimekta.terminal.progress.ProgressLine: Create a progress bar using the line printer and width supplier.
ProgressLine(Spinner, String) - Constructor for class net.morimekta.terminal.progress.ProgressLine: Create a progress bar using the default terminal.
ProgressLine(Terminal, LinePrinter, IntSupplier, Clock, Spinner, String) - Constructor for class net.morimekta.terminal.progress.ProgressLine: Create a progress updater.
ProgressLine(Terminal, Spinner, String) - Constructor for class net.morimekta.terminal.progress.ProgressLine: Create a progress bar using the given terminal.
ProgressManager - Class in net.morimekta.terminal.progress: Show progress on a number of tasks.
ProgressManager(Terminal, Spinner) - Constructor for class net.morimekta.terminal.progress.ProgressManager: Create a progress bar using the given terminal.
ProgressManager(Terminal, Spinner, int) - Constructor for class net.morimekta.terminal.progress.ProgressManager: Create a progress bar using the given terminal.
ProgressManager.ProgressAsyncHandler<T> - Interface in net.morimekta.terminal.progress
ProgressManager.ProgressHandler<T> - Interface in net.morimekta.terminal.progress
property(String, char, String, Property.Putter) - Static method in interface net.morimekta.terminal.args.Property
Property - Interface in net.morimekta.terminal.args
Property.Builder - Interface in net.morimekta.terminal.args
Property.Putter - Interface in net.morimekta.terminal.args: Basic interface for putting values onto a map, properties or config.
propertyLong(String, String, Property.Putter) - Static method in interface net.morimekta.terminal.args.Property
propertyShort(char, String, Property.Putter) - Static method in interface net.morimekta.terminal.args.Property
put(String, String) - Method in interface net.morimekta.terminal.args.Property.Putter: Put the property into place.
put(String, T) - Method in interface net.morimekta.terminal.args.ValueParser.TypedPutter: Put a typed value
putAs(Property.Putter, String) - Static method in interface net.morimekta.terminal.args.ValueParser: Convenience method to put a specific value into a putter.

R

readLine() - Method in class net.morimekta.terminal.input.InputLine: Read line from terminal.
readLine(String) - Method in class net.morimekta.terminal.input.InputLine: Read line from terminal.
readLine(String) - Method in class net.morimekta.terminal.Terminal: Read a line from terminal.
readPassword() - Method in class net.morimekta.terminal.input.InputPassword: Read password from terminal.
repeated() - Method in interface net.morimekta.terminal.args.Argument.Builder
repeated() - Method in interface net.morimekta.terminal.args.Flag.Builder
repeated() - Method in interface net.morimekta.terminal.args.Option.Builder
required() - Method in interface net.morimekta.terminal.args.Argument.Builder
required() - Method in interface net.morimekta.terminal.args.Option.Builder

S

select() - Method in class net.morimekta.terminal.input.InputSelection
select(E) - Method in class net.morimekta.terminal.input.InputSelection
SELECT - net.morimekta.terminal.input.InputSelection.Reaction: Select the entry.
showDefaults(boolean) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
showHidden(boolean) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
showHiddenArguments(boolean) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
showHiddenOptions(boolean) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
showHiddenSubCommands(boolean) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
showSubCommands(boolean) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
singleLineUsagePrefix(String) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
sleep(long) - Method in class net.morimekta.terminal.Terminal
Spinner - Interface in net.morimekta.terminal.progress: Which spinner to show.
STAY - net.morimekta.terminal.input.InputSelection.Reaction: Stay in the selection.
subCommand(String, String, Function<ArgParser.Builder, ? extends SubCommandDef>) - Static method in interface net.morimekta.terminal.args.SubCommand
SubCommand<SubCommandDef> - Interface in net.morimekta.terminal.args
SubCommand.Builder<SubCommandDef> - Interface in net.morimekta.terminal.args
SubCommandSet<SubCommandDef> - Interface in net.morimekta.terminal.args
SubCommandSet.Builder<SubCommandDef> - Interface in net.morimekta.terminal.args
subCommandsHeader(String) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder

T

Terminal - Class in net.morimekta.terminal: Terminal interface.
Terminal() - Constructor for class net.morimekta.terminal.Terminal: Construct a default RAW terminal.
Terminal(TTY) - Constructor for class net.morimekta.terminal.Terminal: Construct a default RAW terminal.
Terminal(TTY, InputStream, OutputStream, LinePrinter, TTYModeSwitcher) - Constructor for class net.morimekta.terminal.Terminal: Constructor visible for testing.
Terminal(TTY, TTYMode) - Constructor for class net.morimekta.terminal.Terminal: Construct a terminal with given mode.
Terminal(TTY, TTYMode, LinePrinter) - Constructor for class net.morimekta.terminal.Terminal: Construct a terminal with a terminal mode and custom line printer.
Terminal(TTY, LinePrinter) - Constructor for class net.morimekta.terminal.Terminal: Construct a terminal with a custom line printer.

U

update(int, String...) - Method in class net.morimekta.terminal.LineBuffer: Update a number of lines starting at a specific offset.
update(int, List<String>) - Method in class net.morimekta.terminal.LineBuffer: Update a number of lines starting at a specific offset.
UPDATE_KEEP_ITEM - net.morimekta.terminal.input.InputSelection.Reaction: Stay in the selection and update entries (clear draw cache and redraw all visible entries).
UPDATE_KEEP_POSITION - net.morimekta.terminal.input.InputSelection.Reaction: Stay in the selection and update entries (clear draw cache and redraw all visible entries).
usageWidth(int) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
usingTTYWidth(TTY) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
usingTTYWidth(TTY, int) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder: Set usage with from the terminal width of the TTY but only up to a maximum.

V

validate() - Method in interface net.morimekta.terminal.args.Arg: Called on all the arguments after the parsing is done to validate if all requirements have been passed.
validate() - Method in interface net.morimekta.terminal.args.ArgParser: Validate all options and arguments.
validate(String, LinePrinter) - Method in interface net.morimekta.terminal.input.InputLine.LineValidator: Validate the full line.
validate(Char, LinePrinter) - Method in interface net.morimekta.terminal.input.InputLine.CharValidator: Validate the given char.
valueOf(String) - Static method in enum net.morimekta.terminal.input.InputSelection.Reaction: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.morimekta.terminal.progress.DefaultSpinners: Returns the enum constant of this type with the specified name.
ValueParser<T> - Interface in net.morimekta.terminal.args: Value parser interface.
ValueParser.DirParser - Class in net.morimekta.terminal.args: A converter to file instances, with validator & error message.
ValueParser.DoubleParser - Class in net.morimekta.terminal.args: A converter to double values.
ValueParser.DurationParser - Class in net.morimekta.terminal.args: A duration parser.
ValueParser.EnumParser<E extends Enum<E>> - Class in net.morimekta.terminal.args: A converter to enum constant values.
ValueParser.FileParser - Class in net.morimekta.terminal.args: A converter to file instances, with validator & error message.
ValueParser.IntegerParser - Class in net.morimekta.terminal.args: A converter to integer values.
ValueParser.LongParser - Class in net.morimekta.terminal.args: A converter to long values.
ValueParser.OutputDirParser - Class in net.morimekta.terminal.args: A converter to file instances, with validator & error message.
ValueParser.OutputFileParser - Class in net.morimekta.terminal.args: A converter to file instances, with validator & error message.
ValueParser.PathParser - Class in net.morimekta.terminal.args: A converter to path values.
ValueParser.TypedPutter<T> - Interface in net.morimekta.terminal.args: A typed putter interface used to put key value pairs into maps, properties etc.
values() - Static method in enum net.morimekta.terminal.input.InputSelection.Reaction: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.morimekta.terminal.progress.DefaultSpinners: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitAbortable() - Method in class net.morimekta.terminal.progress.ProgressManager: Wait for all scheduled tasks to finish allowing the user to abort all tasks with <ctrl>-C.
waitAbortable(Future<T>) - Method in class net.morimekta.terminal.Terminal: Wait for future task to be done or canceled.
warn(String, Object...) - Method in interface net.morimekta.terminal.LinePrinter: Print a warning string message.
when(Predicate<String>) - Method in interface net.morimekta.terminal.args.Argument.Builder
when(Pattern) - Method in interface net.morimekta.terminal.args.Argument.Builder
whenNot(Pattern) - Method in interface net.morimekta.terminal.args.Argument.Builder
withOptionsComparator(Comparator<Option>) - Method in interface net.morimekta.terminal.args.ArgHelp.Builder
withSubCommands(String, String, Consumer<SubCommandDef>) - Method in interface net.morimekta.terminal.args.ArgParser.Builder: Start adding sub-commands, and get the sub-command builder.

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