de.eleon.console.builder

Class AskBuilder

java.lang.Object

de.eleon.console.builder.AskBuilder

public class AskBuilder
extends Object

Ask is a builder for a single Question console.

Method Summary

Modifier and Type	Method and Description
String	answer() Return user input
<T extends Enum<T>> T	answer(Class<T> enumClass) Return user input as T extends Enum.
<T extends Enum<T>> T	answer(Class<T> enumClass, String validationErrorMessage) Return user input as T extends Enum.
<T> T	answer(com.google.common.base.Function<String,T> function) Return user input as T
<T> T	answer(com.google.common.base.Function<String,T> function, String validationErrorMessage) Return user input as T
AskBuilder	completeWith(jline.console.completer.Completer completer) Add completer for tab completion
AnswerOptional	optional() Disable validation of empty user inputs
AskBuilder	useHistory() Enable usage of history.
AskBuilder	useHistoryFrom(String file) Enable usage of history of specific file.
AskBuilder	validateWith(Validator validator) Add validator to validate answer before returning

Methods inherited from class java.lang.Object

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

Method Detail

validateWith

public AskBuilder validateWith(Validator validator)

Add validator to validate answer before returning

Parameters:

validator - Validator to add

Returns:

the builder instance

completeWith

public AskBuilder completeWith(jline.console.completer.Completer completer)

Add completer for tab completion

Parameters:

completer - Completer to add

Returns:

the builder instance

useHistory

public AskBuilder useHistory()

Enable usage of history. History will be saved to ~/.jline/history

Returns:

the builder instance

useHistoryFrom

public AskBuilder useHistoryFrom(String file)

Enable usage of history of specific file. History will be saved to ~/.jline/

Parameters:

file - Filename as String

Returns:

the builder instance

optional

public AnswerOptional optional()

Disable validation of empty user inputs

Returns:

the builder instance

answer

public String answer()

Return user input

Returns:

user input as String

answer

public <T> T answer(com.google.common.base.Function<String,T> function)

Return user input as T

Type Parameters:

T - the return type

Parameters:

function - Function or Transformer for value conversion

Returns:

user input as T

answer

public <T> T answer(com.google.common.base.Function<String,T> function,
                    String validationErrorMessage)

Return user input as T

Type Parameters:

T - the return type

Parameters:

function - Function or Transformer for value conversion

validationErrorMessage - error message if function conversion fails

Returns:

user input as T

answer

public <T extends Enum<T>> T answer(Class<T> enumClass)

Return user input as T extends Enum. Complete with enum values.

Type Parameters:

T - the return type

Parameters:

enumClass - Class of enum to return

Returns:

user input as enum value

answer

public <T extends Enum<T>> T answer(Class<T> enumClass,
                                    String validationErrorMessage)

Return user input as T extends Enum. Complete with enum values.

Type Parameters:

T - the return type

Parameters:

enumClass - Class of enum to return

validationErrorMessage - error message if enum conversion fails

Returns:

user input as enum value