Module org.jline.prompt

Package org.jline.prompt

Interface ToggleBuilder

All Superinterfaces:

BaseBuilder<ToggleBuilder>

All Known Implementing Classes:

DefaultToggleBuilder

public interface ToggleBuilder
extends BaseBuilder<ToggleBuilder>

Builder for toggle prompts.

Method Summary

Modifier and Type	Method	Description
ToggleBuilder	activeLabel(String label)	Set the label for the active (on) state.
ToggleBuilder	defaultValue(boolean defaultValue)	Set the default value.
ToggleBuilder	inactiveLabel(String label)	Set the label for the inactive (off) state.

Methods inherited from interface org.jline.prompt.BaseBuilder

addPrompt, filter, message, name, transformer

Method Details

activeLabel

ToggleBuilder activeLabel(String label)

Set the label for the active (on) state.

Parameters:

label - the active state label (default: "Yes")

Returns:

this builder

inactiveLabel

ToggleBuilder inactiveLabel(String label)

Set the label for the inactive (off) state.

Parameters:

label - the inactive state label (default: "No")

Returns:

this builder

defaultValue

ToggleBuilder defaultValue(boolean defaultValue)

Set the default value.

Parameters:

defaultValue - true for active, false for inactive (default: false)

Returns:

this builder