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

A

ABR - Static variable in interface net.morimekta.console.chr.Char

Abort - [Control c]

accept(long) - Method in class net.morimekta.console.terminal.Progress

Update the progress to reflect the current progress value.

add(O) - Method in class net.morimekta.console.args.ArgumentParser

Add a command line option.

add(A) - Method in class net.morimekta.console.args.ArgumentParser

Add a sub-command.

add(SubCommand<SubCommandDef>) - Method in class net.morimekta.console.args.SubCommandSet

Add a sub-command to the sub-command-set.

add(String...) - Method in class net.morimekta.console.terminal.LineBuffer

Add new lines to the end of the buffer, and print them out.

add(Collection<String>) - Method in class net.morimekta.console.terminal.LineBuffer

Add new lines to the end of the buffer, and print them out.

addAll(SubCommand<SubCommandDef>...) - Method in class net.morimekta.console.args.SubCommandSet

Add a set of sub-commands to the sub-command-set.

addTask(String, long, ProgressManager.ProgressHandler<T>) - Method in class net.morimekta.console.terminal.ProgressManager

Add a task to be done while showing progress.

alt(char) - Static method in class net.morimekta.console.chr.CharUtil

andApply(Consumer<T>) - Method in interface net.morimekta.console.util.Parser

Make a string consumer to typed value consumer out of the converter.

andPut(Parser.TypedPutter<T>) - Method in interface net.morimekta.console.util.Parser

Make a property putter that calls a typed putter with the parsed value.

andPutAs(Parser.TypedPutter<T>, String) - Method in interface net.morimekta.console.util.Parser

Make a consumer that puts a specific value with the typed putter.

apply(ArgumentList) - Method in class net.morimekta.console.args.Argument

apply(ArgumentList) - Method in class net.morimekta.console.args.BaseArgument

Try to apply to the argument.

apply(ArgumentList) - Method in class net.morimekta.console.args.BaseOption

Parse the argument list, including the argument string that triggered the call.

apply(ArgumentList) - Method in class net.morimekta.console.args.Flag

apply(ArgumentList) - Method in class net.morimekta.console.args.Option

apply(ArgumentList) - Method in class net.morimekta.console.args.Property

apply(ArgumentList) - Method in class net.morimekta.console.args.SubCommandSet

applyShort(String, ArgumentList) - Method in class net.morimekta.console.args.BaseOption

When handling a list of short options, except for the last short option.

applyShort(String, ArgumentList) - Method in class net.morimekta.console.args.Flag

applyShort(String, ArgumentList) - Method in class net.morimekta.console.args.Option

applyShort(String, ArgumentList) - Method in class net.morimekta.console.args.Property

Argument - Class in net.morimekta.console.args

An argument is a non-optioned CLI argument.

Argument(String, String, Consumer<String>) - Constructor for class net.morimekta.console.args.Argument

Create a default required argument.

Argument(String, String, Consumer<String>, String) - Constructor for class net.morimekta.console.args.Argument

Create a default optional argument with default value.

Argument(String, String, Consumer<String>, String, Predicate<String>, boolean, boolean, boolean) - Constructor for class net.morimekta.console.args.Argument

Create an argument instance.

ArgumentException - Exception in net.morimekta.console.args

Argument exception.

ArgumentException(String, Object...) - Constructor for exception net.morimekta.console.args.ArgumentException

ArgumentException(Throwable, String, Object...) - Constructor for exception net.morimekta.console.args.ArgumentException

ArgumentList - Class in net.morimekta.console.args

List of arguments with various tools.

ArgumentList(ArgumentList) - Constructor for class net.morimekta.console.args.ArgumentList

ArgumentList(String...) - Constructor for class net.morimekta.console.args.ArgumentList

ArgumentOptions - Class in net.morimekta.console.args

Options for configuring the argument parser.

ArgumentOptions(STTY) - Constructor for class net.morimekta.console.args.ArgumentOptions

ArgumentParser - Class in net.morimekta.console.args

Argument argumentParser class.

ArgumentParser(String, String, String) - Constructor for class net.morimekta.console.args.ArgumentParser

Create an argument argumentParser instance.

ArgumentParser(String, String, String, ArgumentOptions) - Constructor for class net.morimekta.console.args.ArgumentParser

Create an argument argumentParser instance.

ArgumentParser(ArgumentParser, String, String) - Constructor for class net.morimekta.console.args.ArgumentParser

Create a sub-command argument parser for the given sub-command.

asInteger() - Method in interface net.morimekta.console.chr.Char

Unicode codepoint representing this character.

asInteger() - Method in class net.morimekta.console.chr.Control

asInteger() - Method in class net.morimekta.console.chr.Unicode

asString() - Method in class net.morimekta.console.chr.Control

asString() - Method in class net.morimekta.console.chr.Unicode

B

BaseArgument - Class in net.morimekta.console.args

Arguments are part of the args list that is not designated with an option name.

BaseArgument(String, String, String, boolean, boolean, boolean) - Constructor for class net.morimekta.console.args.BaseArgument

BaseOption - Class in net.morimekta.console.args

Argument definition base interface.

BaseOption(String, String, String, String, String, boolean, boolean, boolean) - Constructor for class net.morimekta.console.args.BaseOption

BEL - Static variable in interface net.morimekta.console.chr.Char

Bell.

BG_BLACK - Static variable in class net.morimekta.console.chr.Color

BG_BLUE - Static variable in class net.morimekta.console.chr.Color

BG_CYAN - Static variable in class net.morimekta.console.chr.Color

BG_DEFAULT - Static variable in class net.morimekta.console.chr.Color

BG_GREEN - Static variable in class net.morimekta.console.chr.Color

BG_MAGENTA - Static variable in class net.morimekta.console.chr.Color

BG_RED - Static variable in class net.morimekta.console.chr.Color

BG_WHITE - Static variable in class net.morimekta.console.chr.Color

BG_YELLOW - Static variable in class net.morimekta.console.chr.Color

BLACK - Static variable in class net.morimekta.console.chr.Color

BLUE - Static variable in class net.morimekta.console.chr.Color

BOLD - Static variable in class net.morimekta.console.chr.Color

BS - Static variable in interface net.morimekta.console.chr.Char

Backspace: Not used on Linux

C

call(E, LinePrinter) - Method in interface net.morimekta.console.terminal.InputSelection.Action

Call the command with the given entry.

center(String, int) - Static method in class net.morimekta.console.chr.CharUtil

Pad the each side of the string until the printed width becomes the desired visible string length.

Char - Interface in net.morimekta.console.chr

General interface implemented by character-like classes.

CharReader - Class in net.morimekta.console.chr

A keystroke char reader.

CharReader(InputStream) - Constructor for class net.morimekta.console.chr.CharReader

CharReader(Reader) - Constructor for class net.morimekta.console.chr.CharReader

CharStream - Class in net.morimekta.console.chr

Java 8 streams handling of character sequences.

CharUtil - Class in net.morimekta.console.chr

Common character and console utilities.

CLEAR - Static variable in class net.morimekta.console.chr.Color

clear() - Method in class net.morimekta.console.terminal.LineBuffer

Clear the entire buffer, and the terminal area it represents.

clearLast(int) - Method in class net.morimekta.console.terminal.LineBuffer

Clear the last N lines, and move the cursor to the end of the last remaining line.

clipWidth(String, int) - Static method in class net.morimekta.console.chr.CharUtil

Remove all printable characters after 'width' characters have been filled.

close() - Method in class net.morimekta.console.terminal.Progress

close() - Method in class net.morimekta.console.terminal.ProgressManager

Close the progress and all tasks associated with it.

close() - Method in interface net.morimekta.console.terminal.ProgressTask

close() - Method in class net.morimekta.console.terminal.Terminal

close() - Method in class net.morimekta.console.util.STTYModeSwitcher

Close the terminal mode switcher and turn back the the mode before it was opened.

Color - Class in net.morimekta.console.chr

Unix terminal color helper.

Color(int...) - Constructor for class net.morimekta.console.chr.Color

Create a color with the given modifiers.

Color(Color...) - Constructor for class net.morimekta.console.chr.Color

Combine the given colors.

cols - Variable in class net.morimekta.console.util.TerminalSize

Command(char, String, InputSelection.Action<E>) - Constructor for class net.morimekta.console.terminal.InputSelection.Command

Command(char, String, InputSelection.Action<E>, boolean) - Constructor for class net.morimekta.console.terminal.InputSelection.Command

Command(Char, String, InputSelection.Action<E>) - Constructor for class net.morimekta.console.terminal.InputSelection.Command

Command(Char, String, InputSelection.Action<E>, boolean) - Constructor for class net.morimekta.console.terminal.InputSelection.Command

compareTo(Char) - Method in class net.morimekta.console.chr.Control

compareTo(Char) - Method in class net.morimekta.console.chr.Unicode

complete(String, LinePrinter) - Method in interface net.morimekta.console.terminal.InputLine.TabCompletion

Try to complete the given string.

confirm(String) - Method in class net.morimekta.console.terminal.Terminal

Make a user confirmation.

confirm(String, boolean) - Method in class net.morimekta.console.terminal.Terminal

Make a user confirmation.

consume(int) - Method in class net.morimekta.console.args.ArgumentList

Control - Class in net.morimekta.console.chr

https://en.wikipedia.org/wiki/C0_and_C1_control_codes

count() - Method in class net.morimekta.console.terminal.LineBuffer

CR - Static variable in interface net.morimekta.console.chr.Char

Carriage Return.

CTRL_DOWN - Static variable in class net.morimekta.console.chr.Control

CTRL_LEFT - Static variable in class net.morimekta.console.chr.Control

CTRL_RIGHT - Static variable in class net.morimekta.console.chr.Control

CTRL_UP - Static variable in class net.morimekta.console.chr.Control

currentMode() - Static method in class net.morimekta.console.util.STTYModeSwitcher

Get the current TTY mode.

CURSOR_ERASE - Static variable in class net.morimekta.console.chr.Control

CURSOR_RESTORE - Static variable in class net.morimekta.console.chr.Control

CURSOR_SAVE - Static variable in class net.morimekta.console.chr.Control

cursorDown(int) - Static method in class net.morimekta.console.chr.Control

cursorLeft(int) - Static method in class net.morimekta.console.chr.Control

cursorRight(int) - Static method in class net.morimekta.console.chr.Control

cursorSetPos(int) - Static method in class net.morimekta.console.chr.Control

cursorSetPos(int, int) - Static method in class net.morimekta.console.chr.Control

cursorUp(int) - Static method in class net.morimekta.console.chr.Control

CYAN - Static variable in class net.morimekta.console.chr.Color

D

dbl() - Static method in interface net.morimekta.console.util.Parser

Make a double parser.

dbl(Consumer<Double>) - Static method in interface net.morimekta.console.util.Parser

Make a 64-bit integer parsing consumer.

DEFAULT - Static variable in class net.morimekta.console.chr.Color

defaults() - Static method in class net.morimekta.console.args.ArgumentOptions

defaults(STTY) - Static method in class net.morimekta.console.args.ArgumentOptions

DEL - Static variable in interface net.morimekta.console.chr.Char

DEL, A.K.A.

DELETE - Static variable in class net.morimekta.console.chr.Control

didChangeMode() - Method in class net.morimekta.console.util.STTYModeSwitcher

DIM - Static variable in class net.morimekta.console.chr.Color

dir() - Static method in interface net.morimekta.console.util.Parser

Make a file parser that refers to an existing directory.

dir(Consumer<File>) - Static method in interface net.morimekta.console.util.Parser

Make a file parsing consumer that refers to an existing directory.

DirParser() - Constructor for class net.morimekta.console.util.Parser.DirParser

DoubleParser() - Constructor for class net.morimekta.console.util.Parser.DoubleParser

DOWN - Static variable in class net.morimekta.console.chr.Control

DPAD_MID - Static variable in class net.morimekta.console.chr.Control

E

END - Static variable in class net.morimekta.console.chr.Control

EnumParser(Class<E>) - Constructor for class net.morimekta.console.util.Parser.EnumParser

EOF - Static variable in interface net.morimekta.console.chr.Char

Abort - [Control d]

equals(Object) - Method in class net.morimekta.console.chr.Color

equals(Object) - Method in class net.morimekta.console.chr.Control

equals(Object) - Method in class net.morimekta.console.chr.Unicode

equals(Object) - Method in class net.morimekta.console.util.TerminalSize

error(String, Object...) - Method in interface net.morimekta.console.terminal.LinePrinter

Print an error string message.

ESC - Static variable in interface net.morimekta.console.chr.Char

Escape.

executeAbortable(ExecutorService, Callable<T>) - Method in class net.morimekta.console.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.

executeAbortable(ExecutorService, Runnable) - Method in class net.morimekta.console.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.

expandTabs(String) - Static method in class net.morimekta.console.chr.CharUtil

Expand tabs in string.

expandTabs(String, int) - Static method in class net.morimekta.console.chr.CharUtil

Expand tabs in string.

expandTabs(String, int, int) - Static method in class net.morimekta.console.chr.CharUtil

Expand tabs in string.

F

F1 - Static variable in class net.morimekta.console.chr.Control

F10 - Static variable in class net.morimekta.console.chr.Control

F11 - Static variable in class net.morimekta.console.chr.Control

NOTE: It is common to use F11 to mean 'fullscreen'.

F12 - Static variable in class net.morimekta.console.chr.Control

F2 - Static variable in class net.morimekta.console.chr.Control

F3 - Static variable in class net.morimekta.console.chr.Control

F4 - Static variable in class net.morimekta.console.chr.Control

F5 - Static variable in class net.morimekta.console.chr.Control

F6 - Static variable in class net.morimekta.console.chr.Control

F7 - Static variable in class net.morimekta.console.chr.Control

F8 - Static variable in class net.morimekta.console.chr.Control

F9 - Static variable in class net.morimekta.console.chr.Control

fatal(String, Object...) - Method in interface net.morimekta.console.terminal.LinePrinter

Print a fatal string message.

FF - Static variable in interface net.morimekta.console.chr.Char

Form Feed.

file() - Static method in interface net.morimekta.console.util.Parser

Make a file parser that refers to an existing file.

file(Consumer<File>) - Static method in interface net.morimekta.console.util.Parser

Make a file parsing consumer that refers to an existing file.

FileParser() - Constructor for class net.morimekta.console.util.Parser.FileParser

finish() - Method in class net.morimekta.console.terminal.Terminal

Finish the current set of lines and continue below.

Flag - Class in net.morimekta.console.args

Similar to Option, but without any value argument.

Flag(String, String, String, Consumer<Boolean>) - Constructor for class net.morimekta.console.args.Flag

Flag(String, String, String, Consumer<Boolean>, Boolean) - Constructor for class net.morimekta.console.args.Flag

Flag(String, String, String, Consumer<Boolean>, Boolean, String) - Constructor for class net.morimekta.console.args.Flag

Flag(String, String, String, Consumer<Boolean>, Boolean, boolean) - Constructor for class net.morimekta.console.args.Flag

Flag(String, String, String, Consumer<Boolean>, Boolean, String, boolean) - Constructor for class net.morimekta.console.args.Flag

format(String, Object...) - Method in class net.morimekta.console.terminal.Terminal

formatln(String, Object...) - Method in interface net.morimekta.console.terminal.LinePrinter

Format and print a string message.

FS - Static variable in interface net.morimekta.console.chr.Char

File Separator.

G

get(int) - Method in class net.morimekta.console.args.ArgumentList

getAliases() - Method in class net.morimekta.console.args.SubCommand

Get the list of sub-command aliases.

getArgumentParser(SubCommandDef) - Method in class net.morimekta.console.args.SubCommand

Get the sub-commands internal argument argumentParser initializes with it's own options.

getBefore() - Method in class net.morimekta.console.util.STTYModeSwitcher

Get the mode that was replaced by the switcher.

getCurrentMode() - Method in class net.morimekta.console.util.STTYModeSwitcher

Get the current TTY mode.

getDefaultValue() - Method in class net.morimekta.console.args.BaseArgument

A default value descriptor.

getDescription() - Method in class net.morimekta.console.args.ArgumentParser

Short description of the program.

getMetaKey() - Method in class net.morimekta.console.args.Property

getMetaVar() - Method in class net.morimekta.console.args.BaseOption

Meta variable to show in usage printout.

getMode() - Method in class net.morimekta.console.util.STTYModeSwitcher

Get the mode set by the seitcher.

getName() - Method in class net.morimekta.console.args.BaseArgument

The argument name.

getName() - Method in class net.morimekta.console.args.SubCommand

The sub-command name.

getNegateName() - Method in class net.morimekta.console.args.Flag

The alternative (negating) long name for the flag.

getOptionComparator() - Method in class net.morimekta.console.args.ArgumentOptions

getOutputStream() - Method in class net.morimekta.console.terminal.Terminal

getParser() - Method in exception net.morimekta.console.args.ArgumentException

getPrefix() - Method in class net.morimekta.console.args.Argument

getPrefix() - Method in class net.morimekta.console.args.BaseArgument

Prefix part of the usage usage message.

getPrefix() - Method in class net.morimekta.console.args.BaseOption

getPrefix() - Method in class net.morimekta.console.args.Property

getPrefix() - Method in class net.morimekta.console.args.SubCommandSet

getProgram() - Method in class net.morimekta.console.args.ArgumentParser

The name of the program.

getProgramDescription() - Method in class net.morimekta.console.args.ArgumentParser

Get the program description line.

getShortNames() - Method in class net.morimekta.console.args.BaseOption

Each character of the shortNames string is handled as a short option that is parsed with the -[short] style.

getSingleLineUsage() - Method in class net.morimekta.console.args.Argument

getSingleLineUsage() - Method in class net.morimekta.console.args.ArgumentParser

Get the single line usage string for the parser.

getSingleLineUsage() - Method in class net.morimekta.console.args.BaseArgument

Get the argument's single line usage string.

getSingleLineUsage() - Method in class net.morimekta.console.args.BaseOption

getSingleLineUsage() - Method in class net.morimekta.console.args.Flag

getSingleLineUsage() - Method in class net.morimekta.console.args.Property

getSingleLineUsage(String) - Method in class net.morimekta.console.args.SubCommandSet

Get the single line usage string for a given sub-command.

getSingleLineUsage() - Method in class net.morimekta.console.args.SubCommandSet

getSubCommandsString() - Method in class net.morimekta.console.args.ArgumentOptions

getTerminalSize() - Method in class net.morimekta.console.util.STTY

Get the terminal size.

getTTY() - Method in class net.morimekta.console.terminal.Terminal

getUsage() - Method in class net.morimekta.console.args.BaseArgument

The argument usage description.

getUsage() - Method in class net.morimekta.console.args.SubCommand

The basic usage description.

getUsageWidth() - Method in class net.morimekta.console.args.ArgumentOptions

getVersion() - Method in class net.morimekta.console.args.ArgumentParser

The program version string.

GREEN - Static variable in class net.morimekta.console.chr.Color

GS - Static variable in interface net.morimekta.console.chr.Char

Group Separator.

H

handle(ProgressTask) - Method in interface net.morimekta.console.terminal.ProgressManager.ProgressHandler

hashCode() - Method in class net.morimekta.console.chr.Color

hashCode() - Method in class net.morimekta.console.chr.Control

hashCode() - Method in class net.morimekta.console.chr.Unicode

hashCode() - Method in class net.morimekta.console.util.TerminalSize

HIDDEN - Static variable in class net.morimekta.console.chr.Color

HOME - Static variable in class net.morimekta.console.chr.Control

I

i32() - Static method in interface net.morimekta.console.util.Parser

Make a 32-bit integer parser.

i32(Consumer<Integer>) - Static method in interface net.morimekta.console.util.Parser

Make a 32-bit integer parsing consumer.

i64() - Static method in interface net.morimekta.console.util.Parser

Make a 64-bit integer parser.

i64(Consumer<Long>) - Static method in interface net.morimekta.console.util.Parser

Make a 64-bit integer parsing consumer.

info(String, Object...) - Method in interface net.morimekta.console.terminal.LinePrinter

Print an info string message.

inputBytes(Object...) - Static method in class net.morimekta.console.chr.CharUtil

Make a byte array representing the input bytes for generating the given input.

inputChars(Object...) - Static method in class net.morimekta.console.chr.CharUtil

Make a list of input Chars that e.g.

InputLine - Class in net.morimekta.console.terminal

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.console.terminal.InputLine

Constructor for simple line-input.

InputLine(Terminal, String, InputLine.CharValidator, InputLine.LineValidator, InputLine.TabCompletion) - Constructor for class net.morimekta.console.terminal.InputLine

Constructor for complete line-input.

InputLine(Terminal, String, InputLine.CharValidator, InputLine.LineValidator, InputLine.TabCompletion, Pattern) - Constructor for class net.morimekta.console.terminal.InputLine

Constructor for complete line-input.

InputLine.CharValidator - Interface in net.morimekta.console.terminal

Character validator interface.

InputLine.LineValidator - Interface in net.morimekta.console.terminal

Line validator interface.

InputLine.TabCompletion - Interface in net.morimekta.console.terminal

Tab completion interface.

InputPassword - Class in net.morimekta.console.terminal

Class that handled reading a password from terminal.

InputPassword(Terminal, String) - Constructor for class net.morimekta.console.terminal.InputPassword

Constructor for simple line-input.

InputPassword(Terminal, String, String) - Constructor for class net.morimekta.console.terminal.InputPassword

Constructor for complete line-input.

InputSelection<E> - Class in net.morimekta.console.terminal

Tabular selection with simple navigation.

InputSelection(Terminal, String, List<E>, List<InputSelection.Command<E>>, InputSelection.EntryPrinter<E>) - Constructor for class net.morimekta.console.terminal.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.console.terminal.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.console.terminal.InputSelection

Create a selection instance.

InputSelection.Action<E> - Interface in net.morimekta.console.terminal

The command action interface.

InputSelection.Command<E> - Class in net.morimekta.console.terminal

Command.

InputSelection.EntryPrinter<E> - Interface in net.morimekta.console.terminal

Interface for the entry printer.

InputSelection.Reaction - Enum in net.morimekta.console.terminal

Command reaction enum.

INSERT - Static variable in class net.morimekta.console.chr.Control

IntegerParser() - Constructor for class net.morimekta.console.util.Parser.IntegerParser

INVERT - Static variable in class net.morimekta.console.chr.Color

isDefaultsShown() - Method in class net.morimekta.console.args.ArgumentOptions

isDone() - Method in class net.morimekta.console.terminal.Progress

isDone() - Method in interface net.morimekta.console.terminal.ProgressTask

If the progress task is done or aborted.

isHidden() - Method in class net.morimekta.console.args.BaseArgument

True if the argument should be hidden by default.

isHidden() - Method in class net.morimekta.console.args.SubCommand

If the sub-command is hidden by default.

isInteractive() - Method in class net.morimekta.console.util.STTY

isRepeated() - Method in class net.morimekta.console.args.BaseArgument

If the argument can be repeated (for arguments means to be multi-valued).

isRequired() - Method in class net.morimekta.console.args.BaseArgument

If the argument is required (must be set).

isSubCommandsShown() - Method in class net.morimekta.console.args.ArgumentOptions

iterator(CharSequence) - Static method in class net.morimekta.console.chr.CharStream

L

LEFT - Static variable in class net.morimekta.console.chr.Control

leftPad(String, int) - Static method in class net.morimekta.console.chr.CharUtil

Pad the right side of the string until the printed width becomes the desired visible string length.

length() - Method in interface net.morimekta.console.chr.Char

Number of utf-16 characters that this character takes up if enclosed in a java string.

length() - Method in class net.morimekta.console.chr.Control

length() - Method in class net.morimekta.console.chr.Unicode

lenientIterator(CharSequence) - Static method in class net.morimekta.console.chr.CharStream

lenientStream(CharSequence) - Static method in class net.morimekta.console.chr.CharStream

LF - Static variable in interface net.morimekta.console.chr.Char

Line Feed (newline).

LineBuffer - Class in net.morimekta.console.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.console.terminal.LineBuffer

Create a LineBuffer instance.

LinePrinter - Interface in net.morimekta.console.terminal

LinePrinter interface.

lines() - Method in class net.morimekta.console.terminal.LineBuffer

lines() - Method in class net.morimekta.console.terminal.ProgressManager

LongParser() - Constructor for class net.morimekta.console.util.Parser.LongParser

M

MAGENTA - Static variable in class net.morimekta.console.chr.Color

makeBorder(int, int, int, int) - Static method in class net.morimekta.console.chr.CharUtil

Make a uncode boder symbol matching the lines given.

makeNumeric(int) - Static method in class net.morimekta.console.chr.CharUtil

Gets the unicode char representing a circled number.

N

nameOrShort() - Method in class net.morimekta.console.args.BaseOption

Handy getter mostly to be used in exception naming.

NBSP - Static variable in class net.morimekta.console.chr.Unicode

No-break space.

net.morimekta.console.args - package net.morimekta.console.args

net.morimekta.console.chr - package net.morimekta.console.chr

net.morimekta.console.terminal - package net.morimekta.console.terminal

net.morimekta.console.util - package net.morimekta.console.util

newInstance() - Method in class net.morimekta.console.args.SubCommand

Instantiate the selected commands implementation.

NUL - Static variable in interface net.morimekta.console.chr.Char

Null.

O

oneOf(Class<E>) - Static method in interface net.morimekta.console.util.Parser

Make an enum value parsing consumer.

oneOf(Class<E>, Consumer<E>) - Static method in interface net.morimekta.console.util.Parser

Make a file parsing consumer that refers to an existing file.

Option - Class in net.morimekta.console.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(String, String, String, String, Consumer<String>) - Constructor for class net.morimekta.console.args.Option

Option(String, String, String, String, Consumer<String>, String) - Constructor for class net.morimekta.console.args.Option

Option(String, String, String, String, Consumer<String>, String, boolean, boolean, boolean) - Constructor for class net.morimekta.console.args.Option

outputDir() - Static method in interface net.morimekta.console.util.Parser

Make a parser that refers either to a non-existing entry or an existing directory, but not a file or special device.

outputDir(Consumer<File>) - Static method in interface net.morimekta.console.util.Parser

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.console.util.Parser.OutputDirParser

outputFile() - Static method in interface net.morimekta.console.util.Parser

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<File>) - Static method in interface net.morimekta.console.util.Parser

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.console.util.Parser.OutputFileParser

P

PAGE_DOWN - Static variable in class net.morimekta.console.chr.Control

PAGE_UP - Static variable in class net.morimekta.console.chr.Control

parse(String...) - Method in class net.morimekta.console.args.ArgumentParser

Parse arguments from the main method.

parse(ArgumentList) - Method in class net.morimekta.console.args.ArgumentParser

Parse arguments from the main method.

parse(String) - Method in class net.morimekta.console.util.Parser.DirParser

parse(String) - Method in class net.morimekta.console.util.Parser.DoubleParser

parse(String) - Method in class net.morimekta.console.util.Parser.EnumParser

parse(String) - Method in class net.morimekta.console.util.Parser.FileParser

parse(String) - Method in class net.morimekta.console.util.Parser.IntegerParser

parse(String) - Method in class net.morimekta.console.util.Parser.LongParser

parse(String) - Method in class net.morimekta.console.util.Parser.OutputDirParser

parse(String) - Method in class net.morimekta.console.util.Parser.OutputFileParser

parse(String) - Method in interface net.morimekta.console.util.Parser

Parse the value into a typed instance.

parse(String) - Method in class net.morimekta.console.util.Parser.PathParser

Parser<T> - Interface in net.morimekta.console.util

Value parser interface.

Parser.DirParser - Class in net.morimekta.console.util

A converter to file instances, with validator & error message.

Parser.DoubleParser - Class in net.morimekta.console.util

A converter to double values.

Parser.EnumParser<E extends Enum<E>> - Class in net.morimekta.console.util

A converter to enum constant values.

Parser.FileParser - Class in net.morimekta.console.util

A converter to file instances, with validator & error message.

Parser.IntegerParser - Class in net.morimekta.console.util

A converter to integer values.

Parser.LongParser - Class in net.morimekta.console.util

A converter to long values.

Parser.OutputDirParser - Class in net.morimekta.console.util

A converter to file instances, with validator & error message.

Parser.OutputFileParser - Class in net.morimekta.console.util

A converter to file instances, with validator & error message.

Parser.PathParser - Class in net.morimekta.console.util

A converter to path values.

Parser.TypedPutter<T> - Interface in net.morimekta.console.util

path() - Static method in interface net.morimekta.console.util.Parser

Make a parser that parses a path.

path(Consumer<Path>) - Static method in interface net.morimekta.console.util.Parser

Make a parsing consumer that parses a path.

PathParser() - Constructor for class net.morimekta.console.util.Parser.PathParser

print(E, Color) - Method in interface net.morimekta.console.terminal.InputSelection.EntryPrinter

Print the entry line.

print(E) - Method in interface net.morimekta.console.terminal.InputSelection.EntryPrinter

Print the entry line with default background.

print(Char) - Method in class net.morimekta.console.terminal.Terminal

print(String) - Method in class net.morimekta.console.terminal.Terminal

printableWidth() - Method in interface net.morimekta.console.chr.Char

The number of character spaces taken up by this symbol.

printableWidth(String) - Static method in class net.morimekta.console.chr.CharUtil

How many single-characters worth of console real-estate will be taken up by this string if printed.

printableWidth() - Method in class net.morimekta.console.chr.Control

printableWidth() - Method in class net.morimekta.console.chr.Unicode

printer() - Method in class net.morimekta.console.terminal.Terminal

Get a print stream that writes to the terminal according to the output mode of the terminal.

println(String) - Method in interface net.morimekta.console.terminal.LinePrinter

Print a new line to the terminal.

println(String) - Method in class net.morimekta.console.terminal.Terminal

println() - Method in class net.morimekta.console.terminal.Terminal

printUsage(OutputStream) - Method in class net.morimekta.console.args.ArgumentParser

Print the option usage list.

printUsage(OutputStream, boolean) - Method in class net.morimekta.console.args.ArgumentParser

Print the option usage list.

printUsage(PrintWriter, boolean) - Method in class net.morimekta.console.args.ArgumentParser

Print the option usage list.

printUsage(OutputStream) - Method in class net.morimekta.console.args.SubCommandSet

Print the sub-command list.

printUsage(PrintWriter) - Method in class net.morimekta.console.args.SubCommandSet

Print the sub-command list.

printUsage(OutputStream, boolean) - Method in class net.morimekta.console.args.SubCommandSet

Print the sub-command list.

printUsage(PrintWriter, boolean) - Method in class net.morimekta.console.args.SubCommandSet

Print the sub-command list.

printUsage(OutputStream, String) - Method in class net.morimekta.console.args.SubCommandSet

Print the option usage list for the command.

printUsage(OutputStream, String, boolean) - Method in class net.morimekta.console.args.SubCommandSet

Print the option usage list for the command.

printUsage(PrintWriter, String) - Method in class net.morimekta.console.args.SubCommandSet

Print the option usage list for the command.

printUsage(PrintWriter, String, boolean) - Method in class net.morimekta.console.args.SubCommandSet

Print the option usage list.

Progress - Class in net.morimekta.console.terminal

Show progress on a single task in how many percent (with spinner and progress-bar).

Progress(Terminal, Progress.Spinner, String, long) - Constructor for class net.morimekta.console.terminal.Progress

Create a progress bar using the given terminal.

Progress(LinePrinter, IntSupplier, Progress.Spinner, String, long) - Constructor for class net.morimekta.console.terminal.Progress

Create a progress bar using the line printer and width supplier.

Progress(Terminal, LinePrinter, IntSupplier, Clock, Progress.Spinner, String, long) - Constructor for class net.morimekta.console.terminal.Progress

Create a progress updater.

Progress.Spinner - Enum in net.morimekta.console.terminal

Which spinner to show.

ProgressManager - Class in net.morimekta.console.terminal

Show progress on a number of tasks.

ProgressManager(Terminal, Progress.Spinner) - Constructor for class net.morimekta.console.terminal.ProgressManager

Create a progress bar using the given terminal.

ProgressManager(Terminal, Progress.Spinner, int) - Constructor for class net.morimekta.console.terminal.ProgressManager

Create a progress bar using the given terminal.

ProgressManager.ProgressHandler<T> - Interface in net.morimekta.console.terminal

ProgressTask - Interface in net.morimekta.console.terminal

Show progress on a single task in how many percent (with spinner and progress-bar).

Property - Class in net.morimekta.console.args

A property is an option where the value is a key-value pair, and applies the key value onto a putter.

Property(char, String, Property.Putter) - Constructor for class net.morimekta.console.args.Property

Create a property argument with default key and value names.

Property(String, char, String, Property.Putter) - Constructor for class net.morimekta.console.args.Property

Create a property argument with default key and value names.

Property(char, String, String, String, Property.Putter) - Constructor for class net.morimekta.console.args.Property

Create a property argument.

Property(char, String, String, String, Property.Putter, boolean) - Constructor for class net.morimekta.console.args.Property

Create a property argument.

Property(String, char, String, String, String, Property.Putter, boolean) - Constructor for class net.morimekta.console.args.Property

Create a property argument.

Property.Putter - Interface in net.morimekta.console.args

Basic interface for putting value onto a map, properties or config.

put(String, String) - Method in interface net.morimekta.console.args.Property.Putter

Put the property into place.

put(String, T) - Method in interface net.morimekta.console.util.Parser.TypedPutter

Put a typed value

putAs(Property.Putter, String) - Static method in interface net.morimekta.console.util.Parser

Convenience method to put a specific value into a putter.

R

read() - Method in class net.morimekta.console.chr.CharReader

Read the next char.

readIfAvailable() - Method in class net.morimekta.console.chr.CharReader

Read a single char if ready (something is available in the input stream), otherwise return null.

readLine() - Method in class net.morimekta.console.terminal.InputLine

Read line from terminal.

readLine(String) - Method in class net.morimekta.console.terminal.InputLine

Read line from terminal.

readPassword() - Method in class net.morimekta.console.terminal.InputPassword

Read password from terminal.

RED - Static variable in class net.morimekta.console.chr.Color

remaining() - Method in class net.morimekta.console.args.ArgumentList

RIGHT - Static variable in class net.morimekta.console.chr.Control

rightPad(String, int) - Static method in class net.morimekta.console.chr.CharUtil

Pad the right side of the string until the printed width becomes the desired visible string length.

rows - Variable in class net.morimekta.console.util.TerminalSize

RS - Static variable in interface net.morimekta.console.chr.Char

Record Separator.

S

select() - Method in class net.morimekta.console.terminal.InputSelection

select(E) - Method in class net.morimekta.console.terminal.InputSelection

setParser(ArgumentParser) - Method in exception net.morimekta.console.args.ArgumentException

setSTTYMode(STTYMode) - Method in class net.morimekta.console.util.STTY

Set the current STTY mode, and return the closable switcher to turn back.

setSttyMode(STTYMode) - Method in class net.morimekta.console.util.STTYModeSwitcher

Set terminal mode.

stream(CharSequence) - Static method in class net.morimekta.console.chr.CharStream

stripNonPrintable(String) - Static method in class net.morimekta.console.chr.CharUtil

Strip string of all non-printable characters.

STROKE - Static variable in class net.morimekta.console.chr.Color

STTY - Class in net.morimekta.console.util

A terminal controller helper.

STTY() - Constructor for class net.morimekta.console.util.STTY

STTY(Runtime) - Constructor for class net.morimekta.console.util.STTY

STTYMode - Enum in net.morimekta.console.util

Which IO mode the TTY is in.

STTYModeSwitcher - Class in net.morimekta.console.util

Switch terminal mode and make it return on close.

STTYModeSwitcher(STTYMode, Runtime) - Constructor for class net.morimekta.console.util.STTYModeSwitcher

Switch to the requested mode until closed.

SubCommand<SubCommandDef> - Class in net.morimekta.console.args

Sub command base class.

SubCommand(String, String, Supplier<SubCommandDef>, Function<SubCommandDef, ArgumentParser>, String...) - Constructor for class net.morimekta.console.args.SubCommand

Make a single sub-command.

SubCommand(String, String, Supplier<SubCommandDef>, Function<SubCommandDef, ArgumentParser>, Iterable<String>) - Constructor for class net.morimekta.console.args.SubCommand

Make a single sub-command.

SubCommand(String, String, boolean, Supplier<SubCommandDef>, Function<SubCommandDef, ArgumentParser>, String...) - Constructor for class net.morimekta.console.args.SubCommand

Make a single sub-command.

SubCommand(String, String, boolean, Supplier<SubCommandDef>, Function<SubCommandDef, ArgumentParser>, Iterable<String>) - Constructor for class net.morimekta.console.args.SubCommand

Make a single sub-command.

SubCommandSet<SubCommandDef> - Class in net.morimekta.console.args

The argument part of the sub-command.

SubCommandSet(String, String, Consumer<SubCommandDef>) - Constructor for class net.morimekta.console.args.SubCommandSet

Create a sub-command set.

SubCommandSet(String, String, Consumer<SubCommandDef>, ArgumentOptions) - Constructor for class net.morimekta.console.args.SubCommandSet

Create an optional sub-command set.

SubCommandSet(String, String, Consumer<SubCommandDef>, String) - Constructor for class net.morimekta.console.args.SubCommandSet

Create an optional sub-command set.

SubCommandSet(String, String, Consumer<SubCommandDef>, String, boolean, ArgumentOptions) - Constructor for class net.morimekta.console.args.SubCommandSet

Create an optional sub-command set.

T

TAB - Static variable in interface net.morimekta.console.chr.Char

Horizontal Tab.

TAB_WIDTH - Static variable in class net.morimekta.console.chr.CharUtil

Terminal - Class in net.morimekta.console.terminal

Terminal interface.

Terminal() - Constructor for class net.morimekta.console.terminal.Terminal

Construct a default RAW terminal.

Terminal(STTY) - Constructor for class net.morimekta.console.terminal.Terminal

Construct a default RAW terminal.

Terminal(STTY, STTYMode) - Constructor for class net.morimekta.console.terminal.Terminal

Construct a terminal with given mode.

Terminal(STTY, LinePrinter) - Constructor for class net.morimekta.console.terminal.Terminal

Construct a terminal with a custom line printer.

Terminal(STTY, STTYMode, LinePrinter) - Constructor for class net.morimekta.console.terminal.Terminal

Construct a terminal with a terminal mode and custom line printer.

Terminal(STTY, InputStream, OutputStream, LinePrinter, STTYModeSwitcher) - Constructor for class net.morimekta.console.terminal.Terminal

Constructor visible for testing.

TerminalSize - Class in net.morimekta.console.util

Column and row count for the current terminal.

TerminalSize(int, int) - Constructor for class net.morimekta.console.util.TerminalSize

toString() - Method in class net.morimekta.console.chr.Control

toString() - Method in class net.morimekta.console.chr.Unicode

toString() - Method in class net.morimekta.console.util.STTY

toString() - Method in class net.morimekta.console.util.TerminalSize

U

UNDERLINE - Static variable in class net.morimekta.console.chr.Color

Unicode - Class in net.morimekta.console.chr

Unicode character representation.

Unicode(int) - Constructor for class net.morimekta.console.chr.Unicode

Unicode(char) - Constructor for class net.morimekta.console.chr.Unicode

UNSET_BOLD - Static variable in class net.morimekta.console.chr.Color

UNSET_DIM - Static variable in class net.morimekta.console.chr.Color

UNSET_HIDDEN - Static variable in class net.morimekta.console.chr.Color

UNSET_INVERT - Static variable in class net.morimekta.console.chr.Color

UNSET_STROKE - Static variable in class net.morimekta.console.chr.Color

UNSET_UNDERLINE - Static variable in class net.morimekta.console.chr.Color

UP - Static variable in class net.morimekta.console.chr.Control

update(int, String...) - Method in class net.morimekta.console.terminal.LineBuffer

Update a number of lines starting at a specific offset.

update(int, List<String>) - Method in class net.morimekta.console.terminal.LineBuffer

Update a number of lines starting at a specific offset.

US - Static variable in interface net.morimekta.console.chr.Char

Unit Separator.

V

validate() - Method in class net.morimekta.console.args.Argument

validate() - Method in class net.morimekta.console.args.ArgumentParser

Validate all options and arguments.

validate() - Method in class net.morimekta.console.args.BaseArgument

Called on all the arguments after the parsing is done to validate if all requirements have been passed.

validate() - Method in class net.morimekta.console.args.Flag

validate() - Method in class net.morimekta.console.args.Option

validate() - Method in class net.morimekta.console.args.Property

validate() - Method in class net.morimekta.console.args.SubCommandSet

validate(Char, LinePrinter) - Method in interface net.morimekta.console.terminal.InputLine.CharValidator

Validate the given char.

validate(String, LinePrinter) - Method in interface net.morimekta.console.terminal.InputLine.LineValidator

Validate the full line.

valueOf(String) - Static method in enum net.morimekta.console.terminal.InputSelection.Reaction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.morimekta.console.terminal.Progress.Spinner

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.morimekta.console.util.STTYMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.morimekta.console.terminal.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.console.terminal.Progress.Spinner

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

values() - Static method in enum net.morimekta.console.util.STTYMode

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

VT - Static variable in interface net.morimekta.console.chr.Char

Vertical Tab.

W

waitAbortable() - Method in class net.morimekta.console.terminal.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.console.terminal.Terminal

Wait for future task to be done or canceled.

warn(String, Object...) - Method in interface net.morimekta.console.terminal.LinePrinter

Print a warning string message.

WHITE - Static variable in class net.morimekta.console.chr.Color

withDefaultsShown(boolean) - Method in class net.morimekta.console.args.ArgumentOptions

Set whether the default values should be printed in usage.

withMaxUsageWidth(int) - Method in class net.morimekta.console.args.ArgumentOptions

Set the maximum usage width.

withOptionComparator(Comparator<BaseOption>) - Method in class net.morimekta.console.args.ArgumentOptions

withSubCommandsShown(boolean) - Method in class net.morimekta.console.args.ArgumentOptions

withSubCommandsString(String) - Method in class net.morimekta.console.args.ArgumentOptions

withUsageWidth(int) - Method in class net.morimekta.console.args.ArgumentOptions

Set the number of columns to be used for usage printing.

Y

YELLOW - Static variable in class net.morimekta.console.chr.Color

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