Class CliBuilder<C>

java.lang.Object

com.github.rvesse.airline.builder.AbstractBuilder<Cli<C>>

com.github.rvesse.airline.builder.CliBuilder<C>

Type Parameters:

C - Command type

public class CliBuilder<C>
extends AbstractBuilder<Cli<C>>

Builder for CLIs

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String, HelpSection>	baseHelpSections
protected Class<? extends C>	defaultCommand
protected final List<Class<? extends C>>	defaultCommandGroupCommands
protected String	description
protected final Map<String, GroupBuilder<C>>	groups
protected final String	name
protected String	optionSeparators
protected final ParserBuilder<C>	parserBuilder
protected final List<GlobalRestriction>	restrictions

Constructor Summary

Constructors

Constructor	Description
CliBuilder(String name)

Method Summary

Modifier and Type	Method	Description
Cli<C>	build()	Builds the type
GroupBuilder<C>	getGroup(String name)
CliBuilder<C>	withCommand(Class<? extends C> command)
CliBuilder<C>	withCommands(Class<? extends C> command, Class<? extends C>... moreCommands)
CliBuilder<C>	withCommands(Iterable<Class<? extends C>> commands)
CliBuilder<C>	withDefaultCommand(Class<? extends C> defaultCommand)
CliBuilder<C>	withDefaultRestrictions()
CliBuilder<C>	withDescription(String description)
GroupBuilder<C>	withGroup(String name)
CliBuilder<C>	withHelpSection(HelpSection section)
CliBuilder<C>	withNoRestrictions()
CliBuilder<C>	withOnlyDefaultRestrictions()
ParserBuilder<C>	withParser()
CliBuilder<C>	withRestriction(GlobalRestriction restriction)
CliBuilder<C>	withRestrictions(GlobalRestriction... restrictions)

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

name

protected final String name

description

protected String description

optionSeparators

protected String optionSeparators

defaultCommand

protected Class<? extends C> defaultCommand

defaultCommandGroupCommands

protected final List<Class<? extends C>> defaultCommandGroupCommands

groups

protected final Map<String, GroupBuilder<C>> groups

restrictions

protected final List<GlobalRestriction> restrictions

parserBuilder

protected final ParserBuilder<C> parserBuilder

baseHelpSections

protected final Map<String, HelpSection> baseHelpSections

Constructor Details

CliBuilder

public CliBuilder(String name)

Method Details

withDescription

public CliBuilder<C> withDescription(String description)

withDefaultCommand

public CliBuilder<C> withDefaultCommand(Class<? extends C> defaultCommand)

withCommand

public CliBuilder<C> withCommand(Class<? extends C> command)

withCommands

public CliBuilder<C> withCommands(Class<? extends C> command,
 Class<? extends C>... moreCommands)

withCommands

public CliBuilder<C> withCommands(Iterable<Class<? extends C>> commands)

withGroup

public GroupBuilder<C> withGroup(String name)

getGroup

public GroupBuilder<C> getGroup(String name)

withRestriction

public CliBuilder<C> withRestriction(GlobalRestriction restriction)

withRestrictions

public CliBuilder<C> withRestrictions(GlobalRestriction... restrictions)

withNoRestrictions

public CliBuilder<C> withNoRestrictions()

withDefaultRestrictions

public CliBuilder<C> withDefaultRestrictions()

withOnlyDefaultRestrictions

public CliBuilder<C> withOnlyDefaultRestrictions()

withParser

public ParserBuilder<C> withParser()

withHelpSection

public CliBuilder<C> withHelpSection(HelpSection section)

build

public Cli<C> build()

Description copied from class: AbstractBuilder

Builds the type

Specified by:

build in class AbstractBuilder<Cli<C>>

Returns:

Type instance