Package org.springframework.shell.component.view

Class TerminalUIBuilder

java.lang.Object

org.springframework.shell.component.view.TerminalUIBuilder

public class TerminalUIBuilder
extends Object

Builder that can be used to configure and create a TerminalUI.

Constructor Summary

Constructors

Constructor	Description
TerminalUIBuilder(org.jline.terminal.Terminal terminal, Set<TerminalUICustomizer> customizers, ThemeResolver themeResolver, String themeName)	Create a new TerminalUIBuilder instance.
TerminalUIBuilder(org.jline.terminal.Terminal terminal, TerminalUICustomizer... customizers)	Create a new TerminalUIBuilder instance.

Method Summary

Modifier and Type	Method	Description
TerminalUI	build()	Build a new TerminalUI instance and configure it using this builder.
<T extends TerminalUI> T	configure(T terminalUI)	Configure the provided TerminalUI instance using this builder.
TerminalUIBuilder	customizers(Collection<? extends TerminalUICustomizer> customizers)	Set the TerminalUICustomizer that should be applied to the TerminalUI.
TerminalUIBuilder	themeName(String themeName)	Sets a theme name for TerminalUI to build.
TerminalUIBuilder	themeResolver(ThemeResolver themeResolver)	Sets a ThemeResolver for TerminalUI to build.

Methods inherited from class java.lang.Object

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

Constructor Details

TerminalUIBuilder

public TerminalUIBuilder(org.jline.terminal.Terminal terminal,
 TerminalUICustomizer... customizers)

Create a new TerminalUIBuilder instance.

Parameters:

terminal - the terminal

customizers - any TerminalUICustomizers that should be applied when the TerminalUI is built

TerminalUIBuilder

public TerminalUIBuilder(org.jline.terminal.Terminal terminal,
 Set<TerminalUICustomizer> customizers,
 ThemeResolver themeResolver,
 String themeName)

Create a new TerminalUIBuilder instance.

Parameters:

terminal - the terminal

customizers - any TerminalUICustomizers that should be applied when the TerminalUI is built

themeResolver - the theme resolver

themeName - the theme name

Method Details

themeResolver

public TerminalUIBuilder themeResolver(ThemeResolver themeResolver)

Sets a ThemeResolver for TerminalUI to build.

Parameters:

themeResolver - the theme resolver

Returns:

a new builder instance

themeName

public TerminalUIBuilder themeName(String themeName)

Sets a theme name for TerminalUI to build.

Parameters:

themeName - the theme name

Returns:

a new builder instance

customizers

public TerminalUIBuilder customizers(Collection<? extends TerminalUICustomizer> customizers)

Set the TerminalUICustomizer that should be applied to the TerminalUI. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

Parameters:

customizers - the customizers to set

Returns:

a new builder instance

build

public TerminalUI build()

Build a new TerminalUI instance and configure it using this builder.

Returns:

a configured TerminalUI instance.

configure

public <T extends TerminalUI> T configure(T terminalUI)

Configure the provided TerminalUI instance using this builder.

Type Parameters:

T - the type of terminal ui

Parameters:

terminalUI - the TerminalUI to configure

Returns:

the terminal ui instance