Index (wizard-cli API)

A B C D E F G H I L N P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Action - Interface in nz.org.riskscape.wizard: As well as answering Questions in the wizard, the user can choose to perform an action, such as saving their progress to file or displaying the current pipeline status.
addAnotherValue() - Method in interface nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Messages
AggregationFunctionPrototypeAsker - Class in nz.org.riskscape.wizard.ask: An Asker for FunctionCallPrototypes that will ask extra questions if the chosen aggregation function requires extra arguments for it's configuration.
AggregationFunctionPrototypeAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.AggregationFunctionPrototypeAsker
AggregationFunctionPrototypeAsker.Messages - Interface in nz.org.riskscape.wizard.ask
answerType(String) - Method in interface nz.org.riskscape.wizard.ask.ExpressionAsker.Messages
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.AskAsAsker
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.AttributeAsker
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.BaseAsker: Get a bound value from the user - note that the response's original input is returned from BaseAsker.askUnbound(AskRequest).
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.BooleanExpressionAsker
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.CompatAsker
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.CompositeAsker
ask(AskRequest) - Method in class nz.org.riskscape.wizard.ask.ExpressionAsker
ask(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.CliPrompter: Asks the user a Question and gets a single unbound response (which may or may not be valid).
ask(CliPrompter, IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.AggregationFunctionPrototypeAsker
ask(CliPrompter, IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.ChoiceAsker
ask(CliPrompter, IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.CompatAsker
ask(CliPrompter, IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.DefaultAsker
AskAsAsker - Class in nz.org.riskscape.wizard.ask: Provides a bridge between having a nice CLI UX (via the CompositeAsker) and accepting any aggregate expression for the wizard questions (which simplifies the config and means you can still do some advanced expression-y things with a plain old wizard model).
AskAsAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.AskAsAsker
Asker - Interface in nz.org.riskscape.wizard.ask: Drives a CliPrompter to make it easier for the user to answer it correctly for a particular Question
askIf(String) - Method in class nz.org.riskscape.wizard.CliPrompter: Asks the user a yes/no question
askInteractively(CliPrompter, ExpressionHelper) - Method in class nz.org.riskscape.wizard.ask.BooleanExpressionAsker
askInteractively(CliPrompter, ExpressionHelper) - Method in class nz.org.riskscape.wizard.ask.ExpressionAsker: Build an expression interactively in the wizard, i.e.
AskRequest - Interface in nz.org.riskscape.wizard.ask: Brings together all the arguments to ask in to a single request-like object to make it easier to extend/tweak in the future.
AskRequest.Impl - Class in nz.org.riskscape.wizard.ask: Default implementation
askUnbound(AskRequest) - Method in interface nz.org.riskscape.wizard.ask.Asker: Drive the given CliPrompter to answer the given Question.
askUnbound(AskRequest) - Method in class nz.org.riskscape.wizard.ask.BaseAsker
askUnbound(AskRequest) - Method in class nz.org.riskscape.wizard.ask.CompositeAsker
askWithRepeat(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.CliPrompter: Repeatedly asks the given question until we get a valid response back
AttributeAsker - Class in nz.org.riskscape.wizard.ask: Asker for getting an answer that is a StructDeclaration or PropertyAccess expression, e.g.
AttributeAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.AttributeAsker
AttributeAsker.Messages - Interface in nz.org.riskscape.wizard.ask

B

BaseAsker - Class in nz.org.riskscape.wizard.ask: Base implementation of an Asker that cuts down on boiler plate and also binds the user's input (for validation purposes) before returning the unbound value back to the survey (to make sure that it will bind and the UI isn't doing some magic it's not allowed to - keep in mind that while this UI is part of the same process as the riskscape engine, the wizard has been built so that it can work with a future web UI without huge amounts of re-work)
BaseAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.BaseAsker
bind(Object) - Method in interface nz.org.riskscape.wizard.ask.AskRequest: Bind the given response to something suitable for this ask input's question
BooleanExpressionAsker - Class in nz.org.riskscape.wizard.ask: Asker for getting an answer that is a boolean yielding Expression, such as for a filter condition.
BooleanExpressionAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.BooleanExpressionAsker
BooleanExpressionAsker.Comparison - Enum Class in nz.org.riskscape.wizard.ask: Comparison operators that are supported by the asker.
BooleanExpressionAsker.Messages - Interface in nz.org.riskscape.wizard.ask
BooleanExpressionAsker.ValueEntryMode - Enum Class in nz.org.riskscape.wizard.ask: Represents the user choice in how to answer the attribute value part of the question, should there be a lot of potential values in a list.
byAttributeDisclaimer() - Method in interface nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Messages

C

canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.AggregationFunctionPrototypeAsker
canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.AskAsAsker
canAsk(IncrementalBuildState, Question) - Method in interface nz.org.riskscape.wizard.ask.Asker: Determine whether this Asker is relevant for the given Question and IncrementalBuildState
canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.AttributeAsker
canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.ChoiceAsker
canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.CompositeAsker
canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.DefaultAsker
canAsk(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.ExpressionAsker
canEqual(Object) - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl
CHOICE_INDENT_WIDTH - Static variable in class nz.org.riskscape.wizard.CliPrompter: Account for the '1: ' bit that gets added to the first line of every CLI choice.
ChoiceAsker<T> - Class in nz.org.riskscape.wizard.ask
ChoiceAsker(TranslationContext, Class<?>, Function<Question, List<CliChoice<T>>>) - Constructor for class nz.org.riskscape.wizard.ask.ChoiceAsker
choose(String, List<CliChoice<T>>) - Method in class nz.org.riskscape.wizard.CliPrompter
choose(String, List<T>, Function<T, String>) - Method in class nz.org.riskscape.wizard.CliPrompter
choose(String, List<T>, Function<T, String>, Function<CliChoice<T>, CliChoice<T>>) - Method in class nz.org.riskscape.wizard.CliPrompter: Get the user to choose one of the given items
choose(CommandLine.Help.Ansi.Text, List<CliChoice<T>>) - Method in class nz.org.riskscape.wizard.CliPrompter: Ask the user to choose from the given list of choices, returning the thing that was chosen
chooseAggregationFunction(CliPrompter, IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.ask.AggregationFunctionPrototypeAsker
chooseAttribute() - Method in interface nz.org.riskscape.wizard.ask.ExpressionAsker.Messages
chooseComparison() - Method in interface nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Messages
chooseOptional(String, String, List<T>, Function<T, String>, Function<CliChoice<T>, CliChoice<T>>) - Method in class nz.org.riskscape.wizard.CliPrompter: Get the user to choose one of the given items, also providing a cancel option
chooseValue() - Method in interface nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Messages
CliChoice<T> - Class in nz.org.riskscape.wizard: Used to represent a choice the user has to make as part of a prompt
CliChoice(String, String, T) - Constructor for class nz.org.riskscape.wizard.CliChoice
CliChoice(String, String, T, String) - Constructor for class nz.org.riskscape.wizard.CliChoice
CliChoice(String, T) - Constructor for class nz.org.riskscape.wizard.CliChoice
CliPrompter - Class in nz.org.riskscape.wizard: High-level routines for interacting with the user to guide them through the wizard-answering process
CliPrompter(Terminal, List<Asker>, Asker, Messages, TranslationContext) - Constructor for class nz.org.riskscape.wizard.CliPrompter
CliPrompter.ChooseSwitch - Enum Class in nz.org.riskscape.wizard
CliWizardProcessor2 - Class in nz.org.riskscape.wizard: Drives the wizard answering process on the CLI, this time for Survey2 surveys (rather than the old Survey) interface.
CliWizardProcessor2(Project, CliPrompter, WizardActions) - Constructor for class nz.org.riskscape.wizard.CliWizardProcessor2
CompatAsker - Class in nz.org.riskscape.wizard.ask: Compatibility shim to avoid having to change all the askers now that AskRequest exists
CompatAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.CompatAsker
CompositeAsker - Class in nz.org.riskscape.wizard.ask
CompositeAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.CompositeAsker
CONTINUE_ACTION - Static variable in class nz.org.riskscape.wizard.WizardActions: The action that is returned when the user selects the 'continue' option - allows calling code to detect that they didn't actually want to do anything
create(CliPrompter, IncrementalBuildState, Question) - Static method in interface nz.org.riskscape.wizard.ask.AskRequest: Create a default implementation from the given args
CUSTOM - Enum constant in enum class nz.org.riskscape.wizard.ask.ExpressionAsker.AnswerType

D

data - Variable in class nz.org.riskscape.wizard.CliChoice: An arbitrary java object to associate with the choice
DEFAULT_DISPLAY_WIDTH - Static variable in class nz.org.riskscape.wizard.CliPrompter: 80 chars is a bit boxy, but using the full terminal is too wide on linux
DEFAULT_INDENT_WIDTH - Static variable in class nz.org.riskscape.wizard.CliPrompter: Try to be a little consistent with indenting menu items, where possible.
DEFAULT_PAGE_SIZE - Static variable in class nz.org.riskscape.wizard.ask.BooleanExpressionAsker
DefaultAsker - Class in nz.org.riskscape.wizard.ask
DefaultAsker(TranslationContext) - Constructor for class nz.org.riskscape.wizard.ask.DefaultAsker
displayProblems(String, List<Problem>) - Method in class nz.org.riskscape.wizard.CliPrompter
displayProblems(String, Problem...) - Method in class nz.org.riskscape.wizard.CliPrompter
doCommand(Project) - Method in class nz.org.riskscape.wizard.WizardCommand

E

ENTER_VALUE - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.ValueEntryMode
enterExpression(String) - Method in interface nz.org.riskscape.wizard.ask.ExpressionAsker.Messages
enterNewName() - Method in interface nz.org.riskscape.wizard.ask.AttributeAsker.Messages
enterValue() - Method in interface nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Messages
enumTranslator - Variable in class nz.org.riskscape.wizard.ask.BaseAsker
EQUAL - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison
equals(Object) - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl
ExpressionAsker - Class in nz.org.riskscape.wizard.ask: An Asker for getting an Expression answer that allows the user to either enter the expression themselves, or to build the expression interactively via ExpressionAsker.askInteractively(nz.org.riskscape.wizard.CliPrompter, nz.org.riskscape.wizard.ExpressionHelper)
ExpressionAsker(TranslationContext, List<String>) - Constructor for class nz.org.riskscape.wizard.ask.ExpressionAsker
ExpressionAsker.AnswerType - Enum Class in nz.org.riskscape.wizard.ask: Determines whether the user wants to provide a custom expression manually, or build an expression interactively in the wizard.
ExpressionAsker.Messages - Interface in nz.org.riskscape.wizard.ask
expressionMessages - Variable in class nz.org.riskscape.wizard.ask.ExpressionAsker

F

findAsker(IncrementalBuildState, Question) - Method in interface nz.org.riskscape.wizard.ask.AskRequest
findAsker(IncrementalBuildState, Question) - Method in class nz.org.riskscape.wizard.CliPrompter: We customize how we solicit answers from the user based on the type of answer that the Question expects (i.e.

G

getAllowedExpressionTypes() - Method in class nz.org.riskscape.wizard.ask.ExpressionAsker: Used by ExpressionAsker.canAsk(IncrementalBuildState, Question) to check if the question is for a supported type.
getAskers(TranslationContext) - Static method in class nz.org.riskscape.wizard.WizardCommand
getAttributeChoices(List<Class<? extends Type>>, ExpressionHelper) - Method in class nz.org.riskscape.wizard.ask.ExpressionAsker: Get a list of the ExpressionHelper.AttributeMetadata CliChoices that are available and of an allowedType.
getBindingContext() - Method in interface nz.org.riskscape.wizard.ask.AskRequest
getBuildState() - Method in interface nz.org.riskscape.wizard.ask.AskRequest: The current state of building the pipeline
getBuildState() - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl
getChoices(Class<T>) - Method in class nz.org.riskscape.wizard.ask.BaseAsker
getCliPrompter() - Method in interface nz.org.riskscape.wizard.ask.AskRequest: The CLI that is used to interact with the user
getCliPrompter() - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl
getFeatures() - Method in class nz.org.riskscape.wizard.WizardCliPlugin
getLocale() - Method in class nz.org.riskscape.wizard.ask.BaseAsker
getLocale() - Method in class nz.org.riskscape.wizard.CliPrompter
getMessage(String, Object...) - Method in class nz.org.riskscape.wizard.ask.BaseAsker
getMessages() - Method in class nz.org.riskscape.wizard.CliPrompter
getMessageSource() - Method in class nz.org.riskscape.wizard.ask.BaseAsker
getOperator() - Method in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison
getOptionalMessage(String, Object...) - Method in class nz.org.riskscape.wizard.ask.BaseAsker: Search for a message for this class, conventionally by prepending the class's name to the code, searching through the class hierarchy as well as looking for short class names as well as long names.
getOut() - Method in class nz.org.riskscape.wizard.CliPrompter
getParameterType() - Method in interface nz.org.riskscape.wizard.ask.AskRequest
getProject() - Method in interface nz.org.riskscape.wizard.ask.AskRequest
getPrompt(Question) - Method in class nz.org.riskscape.wizard.CliPrompter: Returns formatted Text containing a question.
getQuestion() - Method in interface nz.org.riskscape.wizard.ask.AskRequest: The question being asked
getQuestion() - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl
getRenderedPipeline(RealizedPipeline) - Method in class nz.org.riskscape.wizard.WizardActions: Renders a RealizedPipeline, as per PipelineRenderer.
getSaveOrShowActions(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions
getSurveyCompleteActions(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions
getTerminal() - Method in class nz.org.riskscape.wizard.CliPrompter
getValueChoices(ExpressionHelper.AttributeMetadata, ExpressionHelper) - Method in class nz.org.riskscape.wizard.ask.ExpressionAsker
GREATER_THAN - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison
GREATER_THAN_EQUAL - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison

H

hashCode() - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl

I

Impl(CliPrompter, IncrementalBuildState, Question) - Constructor for class nz.org.riskscape.wizard.ask.AskRequest.Impl
initializeEngine(Engine) - Method in class nz.org.riskscape.wizard.WizardCliPlugin
INTERACTIVELY - Enum constant in enum class nz.org.riskscape.wizard.ask.ExpressionAsker.AnswerType

L

label - Variable in class nz.org.riskscape.wizard.CliChoice: the main text associated with the choice
LESS_THAN - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison
LESS_THAN_EQUAL - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison

N

NO_SHORTCUT - Static variable in class nz.org.riskscape.wizard.CliChoice
noSuitableDefined(String) - Method in interface nz.org.riskscape.wizard.ask.AggregationFunctionPrototypeAsker.Messages
NOT_EQUAL - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison
nz.org.riskscape.wizard - package nz.org.riskscape.wizard
nz.org.riskscape.wizard.ask - package nz.org.riskscape.wizard.ask

P

PAGED_LIST - Enum constant in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.ValueEntryMode
pickChoice(List<Choice>, CliPrompter, CommandLine.Help.Ansi.Text) - Method in class nz.org.riskscape.wizard.ask.BaseAsker
printBreadcrumb(QuestionTree, Question) - Method in class nz.org.riskscape.wizard.CliPrompter: Prints out a breadcrumb line to the terminal to display the "parentage" for the given chosen question.
printError(String) - Method in class nz.org.riskscape.wizard.CliPrompter
println(Object) - Method in class nz.org.riskscape.wizard.CliPrompter: Shortcut to getOut().println(message)
printlnTitle(String) - Method in class nz.org.riskscape.wizard.CliPrompter: Print a title out to the terminal

R

readline() - Method in class nz.org.riskscape.wizard.CliPrompter
readlineWithTitle(String) - Method in class nz.org.riskscape.wizard.CliPrompter
readlineWithTitle(CommandLine.Help.Ansi.Text) - Method in class nz.org.riskscape.wizard.CliPrompter
renameYesNo() - Method in interface nz.org.riskscape.wizard.ask.AttributeAsker.Messages
run(Survey) - Method in class nz.org.riskscape.wizard.CliWizardProcessor2: Runs through the Survey and interactively asks the user Questions.

S

saveModelIni(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions: Saves the wizard content as a model INI file to the given relativeTo directory (useful for testing).
saveModelIniAndPipeline(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions: Saves both model INI and a pipeline from the buildState
savePipelineDsl(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions: Saves the pipeline produced by the IncrementalBuildState as a plain-text DSL file within the project.ini file's directory.
savePipelineDsl(IncrementalBuildState, String, boolean) - Method in class nz.org.riskscape.wizard.WizardActions: Saves the pipeline DSL to the given relativeTo directory (useful for testing).
shortcut - Variable in class nz.org.riskscape.wizard.CliChoice: A mnemonic that the user can use to pick the choice
SHOW_CANCEL - Enum constant in enum class nz.org.riskscape.wizard.CliPrompter.ChooseSwitch
showAnswers(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions
showInputScope(IncrementalBuildState) - Method in class nz.org.riskscape.wizard.WizardActions
showSuccessMessage(String) - Method in class nz.org.riskscape.wizard.CliPrompter
subtitle - Variable in class nz.org.riskscape.wizard.CliChoice: An optional subtitle to display after the label
subtitled(String) - Method in class nz.org.riskscape.wizard.CliChoice

T

title(String) - Method in class nz.org.riskscape.wizard.CliPrompter
toChoice(EnumTranslator.EnumEntry<T>) - Method in class nz.org.riskscape.wizard.ask.BaseAsker: Allows individual Askers to potentially override how enums get displayed to the user
tooManyChoices(int) - Method in interface nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Messages
toString() - Method in class nz.org.riskscape.wizard.ask.AskRequest.Impl
translationContext - Variable in class nz.org.riskscape.wizard.ask.BaseAsker

U

UndoException - Exception in nz.org.riskscape.wizard: Thrown by an Action used as a sort of long jump (I know it's frowned upon, but it's the simplest way to implement it) to signal the user chose undo from the ctrl-c menu.
UndoException() - Constructor for exception nz.org.riskscape.wizard.UndoException

V

valueOf(String) - Static method in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.ValueEntryMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nz.org.riskscape.wizard.ask.ExpressionAsker.AnswerType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class nz.org.riskscape.wizard.CliPrompter.ChooseSwitch: Returns the enum constant of this class with the specified name.
values() - Static method in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.Comparison: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nz.org.riskscape.wizard.ask.BooleanExpressionAsker.ValueEntryMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nz.org.riskscape.wizard.ask.ExpressionAsker.AnswerType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class nz.org.riskscape.wizard.CliPrompter.ChooseSwitch: Returns an array containing the constants of this enum class, in the order they are declared.

W

WizardActions - Class in nz.org.riskscape.wizard
WizardActions(CliPrompter, URI) - Constructor for class nz.org.riskscape.wizard.WizardActions
WizardCliPlugin - Class in nz.org.riskscape.wizard
WizardCliPlugin(PluginDescriptor) - Constructor for class nz.org.riskscape.wizard.WizardCliPlugin
WizardCommand - Class in nz.org.riskscape.wizard
WizardCommand() - Constructor for class nz.org.riskscape.wizard.WizardCommand

Y

YES_NO_CHOICES - Static variable in class nz.org.riskscape.wizard.CliPrompter

A B C D E F G H I L N P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form