Class ListFormatBuilder<TOption>

java.lang.Object

com.github.rvesse.airline.builder.AbstractBuilder<ListFormat<TOption>>

com.github.rvesse.airline.builder.AbstractChildBuilder<ListFormat<TOption>, Prompt<TOption>, PromptBuilder<TOption>>

com.github.rvesse.airline.prompts.builders.PromptFormatBuilder<TOption>

com.github.rvesse.airline.prompts.builders.ListFormatBuilder<TOption>

Type Parameters:

TOption - Option type

public class ListFormatBuilder<TOption>
extends PromptFormatBuilder<TOption>

A builder that helps building list formats

Field Summary

Fields

Modifier and Type	Field	Description
private int	columns
static final int	DEFAULT_COLUMNS	Default columns used to display list options

Constructor Summary

Constructors

Constructor	Description
ListFormatBuilder(PromptBuilder<TOption> parentBuilder)

Method Summary

Modifier and Type	Method	Description
ListFormat<TOption>	build()	Builds the type
ListFormatBuilder<TOption>	withColumns(int columns)	Specifies the desired number of columns for the listed options
ListFormatBuilder<TOption>	withDefaultColumns()	Specifies that the default number of columns (see DEFAULT_COLUMNS) will be used

Methods inherited from class AbstractChildBuilder

parent

Methods inherited from class AbstractBuilder

checkNotBlank, checkNotEmpty, checkNotNull

Methods inherited from class Object

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

Field Details

DEFAULT_COLUMNS

public static final int DEFAULT_COLUMNS

Default columns used to display list options

See Also:

• Constant Field Values

columns

private int columns

Constructor Details

ListFormatBuilder

public ListFormatBuilder(PromptBuilder<TOption> parentBuilder)

Method Details

withColumns

public ListFormatBuilder<TOption> withColumns(int columns)

Specifies the desired number of columns for the listed options

Parameters:

columns - Columns

Returns:

Format builder

withDefaultColumns

public ListFormatBuilder<TOption> withDefaultColumns()

Specifies that the default number of columns (see DEFAULT_COLUMNS) will be used

Returns:

Format builder

build

public ListFormat<TOption> build()

Description copied from class: AbstractBuilder

Builds the type

Specified by:

build in class AbstractBuilder<ListFormat<TOption>>

Returns:

Type instance