ChoiceItem

All Superinterfaces:: PromptItem

All Known Implementing Classes:: DefaultChoiceItem

public interface ChoiceItem extends PromptItem

Interface for choice items in the Prompter.

Method Summary

Modifier and Type

Method

Description

default Character

getKey()

Get the key associated with this choice.

default boolean

isDefaultChoice()

Whether this choice is the default choice.

Methods inherited from interface org.jline.prompt.PromptItem
getDisabledText, getFooter, getName, getText, isDisabled, isSelectable

Method Details
- isDefaultChoice
  
  default boolean isDefaultChoice()
  
  Whether this choice is the default choice.
  
  Returns:
  
  true if this choice is the default
- getKey
  
  default Character getKey()
  
  Get the key associated with this choice.
  
  Returns:
  
  the key