Module com.github.rvesse.airline

Package com.github.rvesse.airline.builder

Class GroupBuilder<C>

java.lang.Object

com.github.rvesse.airline.builder.AbstractBuilder<CommandGroupMetadata>

com.github.rvesse.airline.builder.AbstractChildBuilder<CommandGroupMetadata,Cli<C>,CliBuilder<C>>

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

public class GroupBuilder<C>
extends AbstractChildBuilder<CommandGroupMetadata,Cli<C>,CliBuilder<C>>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,GroupBuilder<C>>	subGroups

Method Summary

Modifier and Type	Method	Description
CommandGroupMetadata	build()	Builds the type
GroupBuilder<C>	getSubGroup(String name)
GroupBuilder<C>	makeHidden()
GroupBuilder<C>	makeVisible()
GroupBuilder<C>	parentGroup()	Gets the parent group builder which may be null if this is a top level group.
GroupBuilder<C>	withCommand(Class<? extends C> command)
GroupBuilder<C>	withCommands(Class<? extends C> command, Class<? extends C>... moreCommands)
GroupBuilder<C>	withCommands(Iterable<Class<? extends C>> commands)
GroupBuilder<C>	withDefaultCommand(Class<? extends C> defaultCommand)
GroupBuilder<C>	withDescription(String description)	Sets the description for the group
GroupBuilder<C>	withHiddenState(boolean hidden)
GroupBuilder<C>	withSubGroup(String name)

Methods inherited from class com.github.rvesse.airline.builder.AbstractChildBuilder

parent

Methods inherited from class com.github.rvesse.airline.builder.AbstractBuilder

checkNotBlank, checkNotEmpty, checkNotNull

Methods inherited from class java.lang.Object

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

Field Details

subGroups

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

Method Details

withDescription

public GroupBuilder<C> withDescription(String description)

Sets the description for the group

Parameters:

description - Description

Returns:

Group builder

makeHidden

public GroupBuilder<C> makeHidden()

makeVisible

public GroupBuilder<C> makeVisible()

withHiddenState

public GroupBuilder<C> withHiddenState(boolean hidden)

withSubGroup

public GroupBuilder<C> withSubGroup(String name)

getSubGroup

public GroupBuilder<C> getSubGroup(String name)

withDefaultCommand

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

withCommand

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

withCommands

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

withCommands

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

parentGroup

public GroupBuilder<C> parentGroup()

Gets the parent group builder which may be null if this is a top level group. You may alternatively want to call AbstractChildBuilder.parent() to get the actual CLI builder

Returns:

Parent group builder (if any) or null

build

public CommandGroupMetadata build()

Description copied from class: AbstractBuilder

Builds the type

Specified by:

build in class AbstractBuilder<CommandGroupMetadata>

Returns:

Type instance