A B C D E G I L M N P Q R S V W
All Classes All Packages

A

allowsNumericOptionSelection() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets whether options can be selected numerically when using Prompt.promptForOption(boolean)

ambiguousResponse(String) - Static method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils

Provides an error indicating that the response was ambiguous i.e.

B

build() - Method in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder

build() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

C

clearOptions() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Clears all previously specified options

com.github.rvesse.airline.prompts - module com.github.rvesse.airline.prompts

Copyright (C) 2010-16 the original author or authors.

com.github.rvesse.airline.prompts - package com.github.rvesse.airline.prompts

com.github.rvesse.airline.prompts.builders - package com.github.rvesse.airline.prompts.builders

com.github.rvesse.airline.prompts.console - package com.github.rvesse.airline.prompts.console

com.github.rvesse.airline.prompts.errors - package com.github.rvesse.airline.prompts.errors

com.github.rvesse.airline.prompts.formatters - package com.github.rvesse.airline.prompts.formatters

com.github.rvesse.airline.prompts.matchers - package com.github.rvesse.airline.prompts.matchers

ConsolePrompt - Class in com.github.rvesse.airline.prompts.console

A prompt that is backed by System.console()

ConsolePrompt() - Constructor for class com.github.rvesse.airline.prompts.console.ConsolePrompt

Creates a new console prompt using the default System.console()

ConsolePrompt(Console) - Constructor for class com.github.rvesse.airline.prompts.console.ConsolePrompt

Creates a new console prompt using the specified console

D

DEFAULT_COLUMNS - Static variable in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder

Default columns used to display list options

DefaultMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers

Default prompt option matcher

DefaultMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.DefaultMatcher

defaultPrompt() - Static method in class com.github.rvesse.airline.prompts.Prompts

Creates a simple prompt using the default provider (from Prompts.defaultProvider()

defaultProvider() - Static method in class com.github.rvesse.airline.prompts.Prompts

Gets the default provider

displayPrompt(Prompt<T>) - Method in class com.github.rvesse.airline.prompts.formatters.ListFormat

displayPrompt(Prompt<T>) - Method in class com.github.rvesse.airline.prompts.formatters.QuestionFormat

displayPrompt(Prompt<TOption>) - Method in interface com.github.rvesse.airline.prompts.formatters.PromptFormatter

Displays the prompt

E

evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.Exact

evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactIgnoresCase

evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWith

evaluate(TOption) - Method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWithIgnoresCase

Exact(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.Exact

ExactIgnoresCase(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactIgnoresCase

ExactIgnoresCaseMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers

ExactIgnoresCaseMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.ExactIgnoresCaseMatcher

ExactMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers

ExactMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.ExactMatcher

ExactOrStartsWith(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWith

ExactOrStartsWithIgnoresCase(String) - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils.ExactOrStartsWithIgnoresCase

G

getExactMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.DefaultMatcher

Gets an exact matcher

getExactMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.IgnoresCaseMatcher

getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.DefaultMatcher

Gets an exact or partial matcher

getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.ExactIgnoresCaseMatcher

getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.ExactMatcher

getExactOrPartialMatcher(String) - Method in class com.github.rvesse.airline.prompts.matchers.IgnoresCaseMatcher

getMessage() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets the prompt message

getOptionMatcher() - Method in class com.github.rvesse.airline.prompts.Prompt

getOptions() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets the available options (if any)

getPromptWriter() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt

getPromptWriter() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt

getPromptWriter() - Method in interface com.github.rvesse.airline.prompts.PromptProvider

Gets the writer to which prompts should be written

getProvider() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets the prompt provider

getTimeout() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets the configured timeout

getTimeoutUnit() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets the timeout unit

getTypeConverter() - Method in class com.github.rvesse.airline.prompts.Prompt

Gets the configured type converter

I

IgnoresCaseMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers

An option matcher that ignores case

IgnoresCaseMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.IgnoresCaseMatcher

IndexMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers

An option matcher that matches options based on the numeric index of the option using 1 based indexes

IndexMatcher() - Constructor for class com.github.rvesse.airline.prompts.matchers.IndexMatcher

invalidResponse(String) - Static method in class com.github.rvesse.airline.prompts.matchers.MatcherUtils

Provides an error indicating that the response was invalid

L

ListFormat<TOption> - Class in com.github.rvesse.airline.prompts.formatters

A prompt formatter that presents a list of options

ListFormat() - Constructor for class com.github.rvesse.airline.prompts.formatters.ListFormat

Creates a new list format with default columns

ListFormat(int) - Constructor for class com.github.rvesse.airline.prompts.formatters.ListFormat

Creates a new list format with the specified number of columns

ListFormatBuilder<TOption> - Class in com.github.rvesse.airline.prompts.builders

A builder that helps building list formats

ListFormatBuilder(PromptBuilder<TOption>) - Constructor for class com.github.rvesse.airline.prompts.builders.ListFormatBuilder

M

match(Prompt<TOption>, String) - Method in class com.github.rvesse.airline.prompts.matchers.DefaultMatcher

match(Prompt<TOption>, String) - Method in class com.github.rvesse.airline.prompts.matchers.IndexMatcher

match(Prompt<TOption>, String) - Method in interface com.github.rvesse.airline.prompts.matchers.PromptOptionMatcher

Matches the response to an option provided by the prompt

match(Prompt<TOption>, String) - Method in class com.github.rvesse.airline.prompts.matchers.ValueMatcher

MatcherUtils - Class in com.github.rvesse.airline.prompts.matchers

Option matcher utility functions

MatcherUtils() - Constructor for class com.github.rvesse.airline.prompts.matchers.MatcherUtils

MatcherUtils.Exact<TOption> - Class in com.github.rvesse.airline.prompts.matchers

MatcherUtils.ExactIgnoresCase<TOption> - Class in com.github.rvesse.airline.prompts.matchers

MatcherUtils.ExactOrStartsWith<TOption> - Class in com.github.rvesse.airline.prompts.matchers

MatcherUtils.ExactOrStartsWithIgnoresCase<TOption> - Class in com.github.rvesse.airline.prompts.matchers

N

newFreeFormPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts

Creates a free form question prompt

newOptionsPrompt(String, TOption...) - Static method in class com.github.rvesse.airline.prompts.Prompts

Creates a new list prompt

newYesNoAbortPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts

Creates a Yes/No/Abort prompt

newYesNoCancelPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts

Creates a new Yes/No/Cancel prompt

newYesNoPrompt(String) - Static method in class com.github.rvesse.airline.prompts.Prompts

Creates a Yes/No prompt

P

Prompt<TOption> - Class in com.github.rvesse.airline.prompts

Represents a prompt

Prompt(PromptProvider, PromptFormatter, long, TimeUnit, String, Collection<TOption>, PromptOptionMatcher<TOption>, boolean, TypeConverter) - Constructor for class com.github.rvesse.airline.prompts.Prompt

Creates a new prompt

PromptBuilder<TOption> - Class in com.github.rvesse.airline.prompts.builders

A prompt builder is used to define a prompt in a Fluent API style

PromptBuilder() - Constructor for class com.github.rvesse.airline.prompts.builders.PromptBuilder

PromptException - Exception in com.github.rvesse.airline.prompts.errors

PromptException(String) - Constructor for exception com.github.rvesse.airline.prompts.errors.PromptException

PromptException(String, Throwable) - Constructor for exception com.github.rvesse.airline.prompts.errors.PromptException

promptForKey() - Method in class com.github.rvesse.airline.prompts.Prompt

Prompts for a single key

promptForLine() - Method in class com.github.rvesse.airline.prompts.Prompt

Prompts for a line of input

PromptFormatBuilder<TOption> - Class in com.github.rvesse.airline.prompts.builders

A prompt format builder is a child builder of a PromptBuilder used to define the prompt format in a fluent style

PromptFormatBuilder(PromptBuilder<TOption>) - Constructor for class com.github.rvesse.airline.prompts.builders.PromptFormatBuilder

PromptFormatter - Interface in com.github.rvesse.airline.prompts.formatters

Interface for prompt formatters

promptForOption(boolean) - Method in class com.github.rvesse.airline.prompts.Prompt

Prompts for option

promptForSecure() - Method in class com.github.rvesse.airline.prompts.Prompt

Prompts for a secure input line

promptForValue(Class<T>, boolean) - Method in class com.github.rvesse.airline.prompts.Prompt

Prompts for a value

PromptOptionMatcher<TOption> - Interface in com.github.rvesse.airline.prompts.matchers

Interfaces for option matchers that controls how options are matched to the prompt response when using Prompt.promptForOption(boolean)

PromptProvider - Interface in com.github.rvesse.airline.prompts

A provider of prompting

Prompts - Class in com.github.rvesse.airline.prompts

Provides builds for some common

Prompts() - Constructor for class com.github.rvesse.airline.prompts.Prompts

PromptTimeoutException - Exception in com.github.rvesse.airline.prompts.errors

PromptTimeoutException(Prompt<?>, TimeoutException) - Constructor for exception com.github.rvesse.airline.prompts.errors.PromptTimeoutException

Q

QuestionFormat<TOption> - Class in com.github.rvesse.airline.prompts.formatters

Prompt format for simple questions with either a free-form response or with a limited number of options

QuestionFormat() - Constructor for class com.github.rvesse.airline.prompts.formatters.QuestionFormat

Creates a new question format with default columns

QuestionFormat(int) - Constructor for class com.github.rvesse.airline.prompts.formatters.QuestionFormat

Creates a new question format with the specified columns

R

readKey() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt

readKey() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt

readKey() - Method in interface com.github.rvesse.airline.prompts.PromptProvider

Reads a single key from the prompts source

readLine() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt

readLine() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt

readLine() - Method in interface com.github.rvesse.airline.prompts.PromptProvider

Reads a line from the prompts source

readSecureLine() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt

readSecureLine() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt

readSecureLine() - Method in interface com.github.rvesse.airline.prompts.PromptProvider

Reads a line from the prompts source in a secure manner

S

StdIOPrompt - Class in com.github.rvesse.airline.prompts.console

A prompt backed by System.out and System.in

StdIOPrompt() - Constructor for class com.github.rvesse.airline.prompts.console.StdIOPrompt

Creates a new standard IO prompt

StreamPrompt - Class in com.github.rvesse.airline.prompts.console

Creates a new prompt backed by arbitrary streams

StreamPrompt(OutputStream, InputStream) - Constructor for class com.github.rvesse.airline.prompts.console.StreamPrompt

Creates a new stream prompt

supportsSecureReads() - Method in class com.github.rvesse.airline.prompts.console.ConsolePrompt

supportsSecureReads() - Method in class com.github.rvesse.airline.prompts.console.StreamPrompt

supportsSecureReads() - Method in interface com.github.rvesse.airline.prompts.PromptProvider

Whether the provider supports secured reads

V

ValueMatcher<TOption> - Class in com.github.rvesse.airline.prompts.matchers

An option matcher that matches based on actual value rather than strings

ValueMatcher(Class<TOption>) - Constructor for class com.github.rvesse.airline.prompts.matchers.ValueMatcher

Creates a new value matcher

W

waitForPromptResponse(Future<T>) - Method in class com.github.rvesse.airline.prompts.Prompt

Wait for a prompt response

withColumns(int) - Method in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder

Specifies the desired number of columns for the listed options

withDefaultColumns() - Method in class com.github.rvesse.airline.prompts.builders.ListFormatBuilder

Specifies that the default number of columns (see ListFormatBuilder.DEFAULT_COLUMNS) will be used

withDefaultFormatter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that the default formatter should be used, this is the list formatter

withDefaultOptionMatcher() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that the default option matcher be used

withDefaultPromptProvider() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that the default prompt provider should be used

withDefaultTypeConverter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that the default type converter be used

withFormatBuilder() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Switches to a child builder for the prompt format

withFormatBuilder(PromptFormatBuilder<TOption>) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the prompt formatter builder to use

withFormatter(PromptFormatter) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the prompt formatter to use

withListFormatBuilder() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Switches to a child builder for the list formatter

withListFormatter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that a list formatter should be used

withNumericOptionSelection() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Enables numeric option selection

withOption(TOption) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies an option for the prompt

withOptionMatcher(PromptOptionMatcher<TOption>) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the option matcher to use

withOptions(TOption...) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies one/more options for the prompt

withoutNumericOptionSelection() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Disables numeric option selection

withoutTimeout() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that no timeout should be used

withPromptMessage(String) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the prompt message to display

withPromptProvider(PromptProvider) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that the given prompt provider should be used

withQuestionFormatter() - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies that a question formatter should be used

withTimeout(long) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the timeout

withTimeout(long, TimeUnit) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the timeout

withTimeoutUnit(TimeUnit) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the time unit used to apply timeouts to prompts

withTypeConverter(TypeConverter) - Method in class com.github.rvesse.airline.prompts.builders.PromptBuilder

Specifies the type converter to use

A B C D E G I L M N P Q R S V W
All Classes All Packages