Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultSearchPrompt<T>

java.lang.Object

org.jline.prompt.impl.DefaultPrompt

org.jline.prompt.impl.DefaultSearchPrompt<T>

All Implemented Interfaces:

Prompt, SearchPrompt<T>

public class DefaultSearchPrompt<T>
extends DefaultPrompt
implements SearchPrompt<T>

Default implementation of SearchPrompt interface.

Field Summary

Fields inherited from class org.jline.prompt.impl.DefaultPrompt

message, name

Constructor Summary

Constructors

Constructor	Description
DefaultSearchPrompt(String name, String message, Function<String,List<T>> searchFunction, Function<T,String> displayFunction, Function<T,String> valueFunction)
DefaultSearchPrompt(String name, String message, Function<String,List<T>> searchFunction, Function<T,String> displayFunction, Function<T,String> valueFunction, String placeholder, int minSearchLength, int maxResults)

Method Summary

Modifier and Type	Method	Description
Function<T,String>	getDisplayFunction()	Get the function to convert items to display strings.
int	getMaxResults()	Get the maximum number of results to display.
int	getMinSearchLength()	Get the minimum number of characters required before searching.
String	getPlaceholder()	Get the placeholder text to show when no search term is entered.
Function<String,List<T>>	getSearchFunction()	Get the search function that filters items based on the search term.
Function<T,String>	getValueFunction()	Get the function to convert items to their values.

Methods inherited from class org.jline.prompt.impl.DefaultPrompt

getFilter, getMessage, getName, getTransformer, setFilter, setTransformer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.prompt.Prompt

getFilter, getMessage, getName, getTransformer

Constructor Details

DefaultSearchPrompt

public DefaultSearchPrompt(String name,
 String message,
 Function<String,List<T>> searchFunction,
 Function<T,String> displayFunction,
 Function<T,String> valueFunction)

DefaultSearchPrompt

public DefaultSearchPrompt(String name,
 String message,
 Function<String,List<T>> searchFunction,
 Function<T,String> displayFunction,
 Function<T,String> valueFunction,
 String placeholder,
 int minSearchLength,
 int maxResults)

Method Details

getSearchFunction

public Function<String,List<T>> getSearchFunction()

Description copied from interface: SearchPrompt

Get the search function that filters items based on the search term.

Specified by:

getSearchFunction in interface SearchPrompt<T>

Returns:

the search function

getDisplayFunction

public Function<T,String> getDisplayFunction()

Description copied from interface: SearchPrompt

Get the function to convert items to display strings.

Specified by:

getDisplayFunction in interface SearchPrompt<T>

Returns:

the display function

getValueFunction

public Function<T,String> getValueFunction()

Description copied from interface: SearchPrompt

Get the function to convert items to their values.

Specified by:

getValueFunction in interface SearchPrompt<T>

Returns:

the value function

getPlaceholder

public String getPlaceholder()

Description copied from interface: SearchPrompt

Get the placeholder text to show when no search term is entered.

Specified by:

getPlaceholder in interface SearchPrompt<T>

Returns:

the placeholder text

getMinSearchLength

public int getMinSearchLength()

Description copied from interface: SearchPrompt

Get the minimum number of characters required before searching.

Specified by:

getMinSearchLength in interface SearchPrompt<T>

Returns:

the minimum search length

getMaxResults

public int getMaxResults()

Description copied from interface: SearchPrompt

Get the maximum number of results to display.

Specified by:

getMaxResults in interface SearchPrompt<T>

Returns:

the maximum results, or -1 for unlimited