net.morimekta.console.terminal

Class InputLine

java.lang.Object

net.morimekta.console.terminal.InputLine

public class InputLine
extends Object

Class that handled reading a line from terminal input with character and line validators, and optional tab completion.

When writing input into an app it is problematic if the app crashes or exits every time you makes invalid input. This can be solved with the InputLine.CharValidator and InputLine.LineValidator interfaces. The CharValidator validates that any single char input is valid, and will block if not. The LineValidator is triggered when the user finishes the input and checks if the line is valid as a whole, and blocks completion if not.

In addition a InputLine.TabCompletion interface may be provided that can complete input based on the current content before the cursor. If the complete() method returns a string, it will replace what was before.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputLine.CharValidator Character validator interface.
static interface	InputLine.LineValidator Line validator interface.
static interface	InputLine.TabCompletion Tab completion interface.

Constructor Summary

Constructors

Constructor and Description
InputLine(Terminal terminal, String message) Constructor for simple line-input.
InputLine(Terminal terminal, String message, InputLine.CharValidator charValidator, InputLine.LineValidator lineValidator, InputLine.TabCompletion tabCompletion) Constructor for complete line-input.
InputLine(Terminal terminal, String message, InputLine.CharValidator charValidator, InputLine.LineValidator lineValidator, InputLine.TabCompletion tabCompletion, Pattern delimiterPattern) Constructor for complete line-input.

Method Summary

Modifier and Type	Method and Description
String	readLine() Read line from terminal.
String	readLine(String initial) Read line from terminal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputLine

public InputLine(Terminal terminal,
                 String message)

Constructor for simple line-input.

Parameters:

terminal - Terminal to use.

message - Message to print.

InputLine

public InputLine(Terminal terminal,
                 String message,
                 InputLine.CharValidator charValidator,
                 InputLine.LineValidator lineValidator,
                 InputLine.TabCompletion tabCompletion)

Constructor for complete line-input.

Parameters:

terminal - Terminal to use.

message - Message to print.

charValidator - The character validcator or null.

lineValidator - The line validator or null.

tabCompletion - The tab expander or null.

InputLine

public InputLine(Terminal terminal,
                 String message,
                 InputLine.CharValidator charValidator,
                 InputLine.LineValidator lineValidator,
                 InputLine.TabCompletion tabCompletion,
                 Pattern delimiterPattern)

Constructor for complete line-input.

Parameters:

terminal - Terminal to use.

message - Message to print.

charValidator - The character validcator or null.

lineValidator - The line validator or null.

tabCompletion - The tab expander or null.

delimiterPattern - Pattern matching a character that delimit 'words' that are skipped or deleted with [ctrl-left], [ctrl-right], [alt-w] and [alt-d].

Method Detail

readLine

public String readLine()

Read line from terminal.

Returns:

The resulting line.

readLine

public String readLine(String initial)

Read line from terminal.

Parameters:

initial - The initial (default) value.

Returns:

The resulting line.