Package org.springframework.shell.component.flow

Class ComponentFlow.BaseBuilder

java.lang.Object

org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

All Implemented Interfaces:

ComponentFlow.Builder

Direct Known Subclasses:

ComponentFlow.DefaultBuilder

Enclosing interface:

ComponentFlow

public abstract static class ComponentFlow.BaseBuilder
extends Object
implements ComponentFlow.Builder

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Method Details

build

public ComponentFlow build()

Description copied from interface: ComponentFlow.Builder

Builds instance of input wizard.

Specified by:

build in interface ComponentFlow.Builder

Returns:

instance of input wizard

withStringInput

public StringInputSpec withStringInput(String id)

Description copied from interface: ComponentFlow.Builder

Gets a builder for string input.

Specified by:

withStringInput in interface ComponentFlow.Builder

Parameters:

id - the identifier

Returns:

builder for string input

withPathInput

public PathInputSpec withPathInput(String id)

Description copied from interface: ComponentFlow.Builder

Gets a builder for path input.

Specified by:

withPathInput in interface ComponentFlow.Builder

Parameters:

id - the identifier

Returns:

builder for text input

withConfirmationInput

public ConfirmationInputSpec withConfirmationInput(String id)

Description copied from interface: ComponentFlow.Builder

Gets a builder for confirmation input.

Specified by:

withConfirmationInput in interface ComponentFlow.Builder

Parameters:

id - the identifier

Returns:

builder for text input

withSingleItemSelector

public SingleItemSelectorSpec withSingleItemSelector(String id)

Description copied from interface: ComponentFlow.Builder

Gets a builder for single item selector.

Specified by:

withSingleItemSelector in interface ComponentFlow.Builder

Parameters:

id - the identifier

Returns:

builder for single item selector

withMultiItemSelector

public MultiItemSelectorSpec withMultiItemSelector(String id)

Description copied from interface: ComponentFlow.Builder

Gets a builder for multi item selector.

Specified by:

withMultiItemSelector in interface ComponentFlow.Builder

Parameters:

id - the identifier

Returns:

builder for multi item selector

terminal

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

Description copied from interface: ComponentFlow.Builder

Sets a Terminal.

Specified by:

terminal in interface ComponentFlow.Builder

Parameters:

terminal - the terminal

Returns:

a builder

resourceLoader

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

Description copied from interface: ComponentFlow.Builder

Sets a ResourceLoader.

Specified by:

resourceLoader in interface ComponentFlow.Builder

Parameters:

resourceLoader - the resource loader

Returns:

a builder

templateExecutor

public ComponentFlow.Builder templateExecutor(TemplateExecutor templateExecutor)

Description copied from interface: ComponentFlow.Builder

Sets a TemplateExecutor.

Specified by:

templateExecutor in interface ComponentFlow.Builder

Parameters:

templateExecutor - the template executor

Returns:

a builder

clone

public ComponentFlow.Builder clone()

Description copied from interface: ComponentFlow.Builder

Clones existing builder.

Specified by:

clone in interface ComponentFlow.Builder

Overrides:

clone in class Object

Returns:

a builder

reset

public ComponentFlow.Builder reset()

Description copied from interface: ComponentFlow.Builder

Resets existing builder.

Specified by:

reset in interface ComponentFlow.Builder

Returns:

a builder