org.springframework.shell.component.flow

Interface ComponentFlow.Builder

All Known Implementing Classes:

ComponentFlow.BaseBuilder, ComponentFlow.DefaultBuilder

Enclosing interface:

ComponentFlow

public static interface ComponentFlow.Builder

Interface for a wizard builder.

Method Summary

Modifier and Type	Method and Description
ComponentFlow	build() Builds instance of input wizard.
ComponentFlow.Builder	clone() Clones existing builder.
ComponentFlow.Builder	reset() Resets existing builder.
ComponentFlow.Builder	resourceLoader(org.springframework.core.io.ResourceLoader resourceLoader) Sets a ResourceLoader.
ComponentFlow.Builder	templateExecutor(TemplateExecutor templateExecutor) Sets a TemplateExecutor.
ComponentFlow.Builder	terminal(org.jline.terminal.Terminal terminal) Sets a Terminal.
ConfirmationInputSpec	withConfirmationInput(String id) Gets a builder for confirmation input.
MultiItemSelectorSpec	withMultiItemSelector(String id) Gets a builder for multi item selector.
PathInputSpec	withPathInput(String id) Gets a builder for path input.
SingleItemSelectorSpec	withSingleItemSelector(String id) Gets a builder for single item selector.
StringInputSpec	withStringInput(String id) Gets a builder for string input.

Method Detail

withStringInput

StringInputSpec withStringInput(String id)

Gets a builder for string input.

Parameters:

id - the identifier

Returns:

builder for string input

withPathInput

PathInputSpec withPathInput(String id)

Gets a builder for path input.

Parameters:

id - the identifier

Returns:

builder for text input

withConfirmationInput

ConfirmationInputSpec withConfirmationInput(String id)

Gets a builder for confirmation input.

Parameters:

id - the identifier

Returns:

builder for text input

withSingleItemSelector

SingleItemSelectorSpec withSingleItemSelector(String id)

Gets a builder for single item selector.

Parameters:

id - the identifier

Returns:

builder for single item selector

withMultiItemSelector

MultiItemSelectorSpec withMultiItemSelector(String id)

Gets a builder for multi item selector.

Parameters:

id - the identifier

Returns:

builder for multi item selector

terminal

ComponentFlow.Builder terminal(org.jline.terminal.Terminal terminal)

Sets a Terminal.

Parameters:

terminal - the terminal

Returns:

a builder

resourceLoader

ComponentFlow.Builder resourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Sets a ResourceLoader.

Parameters:

resourceLoader - the resource loader

Returns:

a builder

templateExecutor

ComponentFlow.Builder templateExecutor(TemplateExecutor templateExecutor)

Sets a TemplateExecutor.

Parameters:

templateExecutor - the template executor

Returns:

a builder

clone

ComponentFlow.Builder clone()

Clones existing builder.

Returns:

a builder

reset

ComponentFlow.Builder reset()

Resets existing builder.

Returns:

a builder

build

ComponentFlow build()

Builds instance of input wizard.

Returns:

instance of input wizard