B C D E F G I J L M N O P R S T V W

B

BooleanInputReader - Class in org.beryx.textio

A reader for boolean values.

BooleanInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.BooleanInputReader

ByteInputReader - Class in org.beryx.textio

A reader for byte values.

ByteInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.ByteInputReader

C

CharInputReader - Class in org.beryx.textio

A reader for char values.

CharInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.CharInputReader

checkConfiguration() - Method in class org.beryx.textio.ComparableInputReader

In addition to the checks performed by InputReader.checkConfiguration(), it checks if minVal <= maxVal

checkConfiguration() - Method in class org.beryx.textio.InputReader

Checks if the reader is correctly configured.

checkConfiguration() - Method in class org.beryx.textio.StringInputReader

In addition to the checks performed by InputReader.checkConfiguration(), it checks if minVal <= maxVal

ColorTextTerminal - Class in org.beryx.textio.demo

ColorTextTerminal() - Constructor for class org.beryx.textio.demo.ColorTextTerminal

ComparableInputReader<T extends Comparable<T>,B extends ComparableInputReader<T,B>> - Class in org.beryx.textio

A reader for values of y type that implements Comparable.

ComparableInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.ComparableInputReader

ConsoleTextTerminal - Class in org.beryx.textio.console

A TextTerminal backed by a Console.

ConsoleTextTerminal() - Constructor for class org.beryx.textio.console.ConsoleTextTerminal

ConsoleTextTerminal(Console) - Constructor for class org.beryx.textio.console.ConsoleTextTerminal

ConsoleTextTerminalProvider - Class in org.beryx.textio.console

If System.console() is not null, it provides a ConsoleTextTerminal.

ConsoleTextTerminalProvider() - Constructor for class org.beryx.textio.console.ConsoleTextTerminalProvider

D

defaultValue - Variable in class org.beryx.textio.InputReader

null, if there is no default value

display() - Method in class org.beryx.textio.swing.SwingTextTerminal

dispose() - Method in class org.beryx.textio.swing.SwingTextTerminal

dispose() - Method in class org.beryx.textio.TextIO

dispose() - Method in interface org.beryx.textio.TextTerminal

This method is typically called at the end of a text-based input/output session in order to allow the terminal to release its screen resources.

DoubleInputReader - Class in org.beryx.textio

A reader for double values.

DoubleInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.DoubleInputReader

E

EnumInputReader<T extends Enum<T>> - Class in org.beryx.textio

A reader for enum values.

EnumInputReader(Supplier<TextTerminal>, Class<T>) - Constructor for class org.beryx.textio.EnumInputReader

equalsFunc - Variable in class org.beryx.textio.InputReader

The function used to check whether two values are equal.

F

FloatInputReader - Class in org.beryx.textio

A reader for float values.

FloatInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.FloatInputReader

G

GenericInputReader<T> - Class in org.beryx.textio

A reader for values of a type T, for which a parser is passed as constructor argument.

GenericInputReader(Supplier<TextTerminal>, Function<String, InputReader.ParseResult<T>>) - Constructor for class org.beryx.textio.GenericInputReader

getDefaultErrorMessage(String) - Method in class org.beryx.textio.InputReader

Returns a generic error message.

getDefaultErrorMessages(String) - Method in class org.beryx.textio.BooleanInputReader

getDefaultErrorMessages(String) - Method in class org.beryx.textio.InputReader

If no InputReader.parseErrorMessagesProvider exists, this method is used to provide the list of error messages for the input string s.

getErrorMessages(String, String) - Method in interface org.beryx.textio.InputReader.ErrorMessagesProvider

Returns the list of error messages for the given string representation of the value

getErrorMessages(String) - Method in class org.beryx.textio.InputReader

Provides the list of error messages for the input string s.

getErrorMessages() - Method in class org.beryx.textio.InputReader.ParseResult

getErrorMessages(T, String) - Method in interface org.beryx.textio.InputReader.ValueChecker

Returns the list of error messages due to constraint violations caused by val

getFrame() - Method in class org.beryx.textio.swing.SwingTextTerminal

getLengthValidationErrors(String) - Method in class org.beryx.textio.StringInputReader

getMinMaxErrorMessage(T) - Method in class org.beryx.textio.ComparableInputReader

getPatternValidationErrors(String) - Method in class org.beryx.textio.StringInputReader

getPossibleValue(T) - Method in class org.beryx.textio.InputReader

getReader() - Method in class org.beryx.textio.jline.JLineTextTerminal

getTextArea() - Method in class org.beryx.textio.swing.SwingTextTerminal

getTextIO() - Static method in class org.beryx.textio.TextIoFactory

getTextTerminal() - Method in class org.beryx.textio.console.ConsoleTextTerminalProvider

getTextTerminal() - Method in class org.beryx.textio.jline.JLineTextTerminalProvider

getTextTerminal() - Method in class org.beryx.textio.swing.SwingTextTerminalProvider

getTextTerminal() - Method in class org.beryx.textio.system.SystemTextTerminalProvider

getTextTerminal() - Method in class org.beryx.textio.TextIO

getTextTerminal() - Static method in class org.beryx.textio.TextIoFactory

getTextTerminal() - Method in interface org.beryx.textio.TextTerminalProvider

getValue() - Method in class org.beryx.textio.InputReader.ParseResult

I

inlinePossibleValues - Variable in class org.beryx.textio.InputReader

If true, the list of possible values will be displayed on a single line.

inputMasking - Variable in class org.beryx.textio.InputReader

If true, the input will be masked (useful for example when reading passwords)

InputReader<T,B extends InputReader<T,B>> - Class in org.beryx.textio

A reader for values of type T.

InputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.InputReader

InputReader.ErrorMessagesProvider - Interface in org.beryx.textio

Functional interface for providing error messages

InputReader.ParseResult<T> - Class in org.beryx.textio

A holder object returned by the InputReader.parse(String) method, containing the parsed value and/or the error messages.

InputReader.ValueChecker<T> - Interface in org.beryx.textio

Functional interface for checking value constraints

inputTrimming - Variable in class org.beryx.textio.InputReader

If true, the input will be trimmed.

IntInputReader - Class in org.beryx.textio

A reader for int values.

IntInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.IntInputReader

isInRange(T) - Method in class org.beryx.textio.ComparableInputReader

Returns true if minVal <= val <= maxVal

isPossibleValue(T) - Method in class org.beryx.textio.InputReader

isValueListMode() - Method in class org.beryx.textio.InputReader

J

JLineTextTerminal - Class in org.beryx.textio.jline

A JLine-based TextTerminal.

JLineTextTerminal(ConsoleReader) - Constructor for class org.beryx.textio.jline.JLineTextTerminal

JLineTextTerminalProvider - Class in org.beryx.textio.jline

If System.console() is not null and a ConsoleReader can be created, it provides a JLineTextTerminal.

JLineTextTerminalProvider() - Constructor for class org.beryx.textio.jline.JLineTextTerminalProvider

L

LongInputReader - Class in org.beryx.textio

A reader for long values.

LongInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.LongInputReader

M

main(String[]) - Static method in class org.beryx.textio.demo.TextIoDemo

maxVal - Variable in class org.beryx.textio.ComparableInputReader

minVal - Variable in class org.beryx.textio.ComparableInputReader

N

newBooleanInputReader() - Method in class org.beryx.textio.TextIO

newByteInputReader() - Method in class org.beryx.textio.TextIO

newCharInputReader() - Method in class org.beryx.textio.TextIO

newDoubleInputReader() - Method in class org.beryx.textio.TextIO

newEnumInputReader(Class<T>) - Method in class org.beryx.textio.TextIO

newFloatInputReader() - Method in class org.beryx.textio.TextIO

newGenericInputReader(Function<String, InputReader.ParseResult<T>>) - Method in class org.beryx.textio.TextIO

newIntInputReader() - Method in class org.beryx.textio.TextIO

newLongInputReader() - Method in class org.beryx.textio.TextIO

newShortInputReader() - Method in class org.beryx.textio.TextIO

newStringInputReader() - Method in class org.beryx.textio.TextIO

noDuplicatesChecker() - Static method in class org.beryx.textio.InputReader

nonEmptyListChecker() - Static method in class org.beryx.textio.InputReader

numberedPossibleValues - Variable in class org.beryx.textio.InputReader

If true, the list of possible values will be numbered and the desired value will be selected by choosing the corresponding number.

O

org.beryx.textio - package org.beryx.textio

org.beryx.textio.console - package org.beryx.textio.console

org.beryx.textio.demo - package org.beryx.textio.demo

org.beryx.textio.jline - package org.beryx.textio.jline

org.beryx.textio.swing - package org.beryx.textio.swing

org.beryx.textio.system - package org.beryx.textio.system

P

parse(String) - Method in class org.beryx.textio.BooleanInputReader

parse(String) - Method in class org.beryx.textio.ByteInputReader

parse(String) - Method in class org.beryx.textio.CharInputReader

parse(String) - Method in class org.beryx.textio.DoubleInputReader

parse(String) - Method in class org.beryx.textio.EnumInputReader

parse(String) - Method in class org.beryx.textio.FloatInputReader

parse(String) - Method in class org.beryx.textio.GenericInputReader

parse(String) - Method in class org.beryx.textio.InputReader

Parses the input string

parse(String) - Method in class org.beryx.textio.IntInputReader

parse(String) - Method in class org.beryx.textio.LongInputReader

parse(String) - Method in class org.beryx.textio.ShortInputReader

parse(String) - Method in class org.beryx.textio.StringInputReader

parseAndCheck(String) - Method in class org.beryx.textio.InputReader

Parses the input string and runs all value checkers in order to find constraint violations.

parseErrorMessagesProvider - Variable in class org.beryx.textio.InputReader

The provider of parse error messages.

parser - Variable in class org.beryx.textio.GenericInputReader

ParseResult(T) - Constructor for class org.beryx.textio.InputReader.ParseResult

ParseResult(T, List<String>) - Constructor for class org.beryx.textio.InputReader.ParseResult

ParseResult(T, String...) - Constructor for class org.beryx.textio.InputReader.ParseResult

possibleValues - Variable in class org.beryx.textio.InputReader

Non-null and non-empty, if the value to be read must be chosen from a list of allowed values.

print(String) - Method in interface org.beryx.textio.TextTerminal

Prints a message that possibly contains line separators.

print(List<String>) - Method in interface org.beryx.textio.TextTerminal

Prints each message in the list, inserting the line separator string between messages.

printf(String, Object...) - Method in interface org.beryx.textio.TextTerminal

printf(Locale, String, Object...) - Method in interface org.beryx.textio.TextTerminal

println() - Method in class org.beryx.textio.console.ConsoleTextTerminal

println() - Method in class org.beryx.textio.jline.JLineTextTerminal

println() - Method in class org.beryx.textio.swing.SwingTextTerminal

println() - Method in class org.beryx.textio.system.SystemTextTerminal

println() - Method in interface org.beryx.textio.TextTerminal

Terminates the current line by writing the line separator string.

println(String) - Method in interface org.beryx.textio.TextTerminal

Prints a message that possibly contains line separators and subsequently prints a line separator.

println(List<String>) - Method in interface org.beryx.textio.TextTerminal

Prints each message in the list, inserting the line separator string between messages.

printPrompt(List<String>, TextTerminal) - Method in class org.beryx.textio.BooleanInputReader

printPrompt(List<String>, TextTerminal) - Method in class org.beryx.textio.InputReader

Displays a prompt inviting the user to enter a value.

promptAdjustments - Variable in class org.beryx.textio.InputReader

If true, the input reader is allowed to tweak the prompter, for example by including the default value or appending a colon at the end.

propertyName - Variable in class org.beryx.textio.InputReader

The name of the property corresponding to the value to be read.

R

rawPrint(String) - Method in class org.beryx.textio.console.ConsoleTextTerminal

rawPrint(String) - Method in class org.beryx.textio.demo.ColorTextTerminal

rawPrint(String) - Method in class org.beryx.textio.jline.JLineTextTerminal

rawPrint(String) - Method in class org.beryx.textio.swing.SwingTextTerminal

rawPrint(String) - Method in class org.beryx.textio.system.SystemTextTerminal

rawPrint(String) - Method in interface org.beryx.textio.TextTerminal

Prints the message in its raw form.

rawPrint(List<String>) - Method in interface org.beryx.textio.TextTerminal

Prints each message in the list in its raw form, inserting the line separator string between messages.

read(boolean) - Method in class org.beryx.textio.console.ConsoleTextTerminal

read(String...) - Method in class org.beryx.textio.InputReader

Reads a value of type T.

read(List<String>) - Method in class org.beryx.textio.InputReader

Reads a value of type T.

read(boolean) - Method in class org.beryx.textio.jline.JLineTextTerminal

read(boolean) - Method in class org.beryx.textio.swing.SwingTextTerminal

read(boolean) - Method in class org.beryx.textio.system.SystemTextTerminal

read(boolean) - Method in interface org.beryx.textio.TextTerminal

Reads a line of text

readList(String...) - Method in class org.beryx.textio.InputReader

readList(List<String>) - Method in class org.beryx.textio.InputReader

S

ShortInputReader - Class in org.beryx.textio

A reader for short values.

ShortInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.ShortInputReader

StringInputReader - Class in org.beryx.textio

A reader for string values.

StringInputReader(Supplier<TextTerminal>) - Constructor for class org.beryx.textio.StringInputReader

SwingTextTerminal - Class in org.beryx.textio.swing

A TextTerminal implemented using a JTextArea inside a JFrame.

SwingTextTerminal() - Constructor for class org.beryx.textio.swing.SwingTextTerminal

SwingTextTerminalProvider - Class in org.beryx.textio.swing

If the system is not headless, it provides a SwingTextTerminal.

SwingTextTerminalProvider() - Constructor for class org.beryx.textio.swing.SwingTextTerminalProvider

SystemTextTerminal - Class in org.beryx.textio.system

A TextTerminal implemented using System.out, System.in and Scanner.

SystemTextTerminal() - Constructor for class org.beryx.textio.system.SystemTextTerminal

SystemTextTerminalProvider - Class in org.beryx.textio.system

It provides a SystemTextTerminal.

SystemTextTerminalProvider() - Constructor for class org.beryx.textio.system.SystemTextTerminalProvider

T

TEXT_TERMINAL_CLASS_PROPERTY - Static variable in class org.beryx.textio.TextIoFactory

TextIO - Class in org.beryx.textio

A factory for creating InputReaders.

TextIO(TextTerminal) - Constructor for class org.beryx.textio.TextIO

TextIoDemo - Class in org.beryx.textio.demo

Demo application illustrating the use of TextIO.

TextIoDemo() - Constructor for class org.beryx.textio.demo.TextIoDemo

TextIoFactory - Class in org.beryx.textio

Provides TextTerminal and TextIO implementations.

TextIoFactory() - Constructor for class org.beryx.textio.TextIoFactory

TextTerminal - Interface in org.beryx.textio

Interface for text-based terminals capable of reading (optionally masking the input) and writing text.

TextTerminalProvider - Interface in org.beryx.textio

TextTerminal Service Provider Interface

textTerminalSupplier - Variable in class org.beryx.textio.InputReader

Supplier of s

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.ByteInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.CharInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.ComparableInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.DoubleInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.FloatInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.IntInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.LongInputReader

typeNameWithIndefiniteArticle() - Method in class org.beryx.textio.ShortInputReader

V

valueCheckers - Variable in class org.beryx.textio.InputReader

The list of value checkers used to detect constraint violations

valueFormatter - Variable in class org.beryx.textio.InputReader

The formatter used when displaying values of type T.

valueListCheckers - Variable in class org.beryx.textio.InputReader

The list of value checkers used to detect constraint violations for a list of values

W

withAllValues() - Method in class org.beryx.textio.EnumInputReader

withAllValuesInline() - Method in class org.beryx.textio.EnumInputReader

withAllValuesNumbered() - Method in class org.beryx.textio.EnumInputReader

withDefaultValue(T) - Method in class org.beryx.textio.InputReader

withEqualsFunc(BiFunction<T, T, Boolean>) - Method in class org.beryx.textio.InputReader

withFalseInput(String) - Method in class org.beryx.textio.BooleanInputReader

Configures the string value that corresponds to false.

withIgnoreCase() - Method in class org.beryx.textio.StringInputReader

withInlinePossibleValues(T...) - Method in class org.beryx.textio.InputReader

withInlinePossibleValues(List<T>) - Method in class org.beryx.textio.InputReader

withInputMasking(boolean) - Method in class org.beryx.textio.InputReader

withInputTrimming(boolean) - Method in class org.beryx.textio.InputReader

withMaxLength(int) - Method in class org.beryx.textio.StringInputReader

withMaxVal(T) - Method in class org.beryx.textio.ComparableInputReader

Configures the maximum allowed value

withMinLength(int) - Method in class org.beryx.textio.StringInputReader

withMinVal(T) - Method in class org.beryx.textio.ComparableInputReader

Configures the minimum allowed value

withNumberedPossibleValues(T...) - Method in class org.beryx.textio.InputReader

withNumberedPossibleValues(List<T>) - Method in class org.beryx.textio.InputReader

withParseErrorMessagesProvider(InputReader.ErrorMessagesProvider) - Method in class org.beryx.textio.InputReader

withPattern(String) - Method in class org.beryx.textio.StringInputReader

withPattern(String, int) - Method in class org.beryx.textio.StringInputReader

withPossibleValues(T...) - Method in class org.beryx.textio.InputReader

withPossibleValues(List<T>) - Method in class org.beryx.textio.InputReader

withPromptAdjustments(boolean) - Method in class org.beryx.textio.InputReader

withPropertyName(String) - Method in class org.beryx.textio.InputReader

withTrueInput(String) - Method in class org.beryx.textio.BooleanInputReader

Configures the string value that corresponds to true.

withValueChecker(InputReader.ValueChecker<T>) - Method in class org.beryx.textio.InputReader

Adds the valueChecker passed as argument.

withValueFormatter(Function<T, String>) - Method in class org.beryx.textio.InputReader

withValueListChecker(InputReader.ValueChecker<List<T>>) - Method in class org.beryx.textio.InputReader

Adds the valueListChecker passed as argument.

B C D E F G I J L M N O P R S T V W