Uses of Interface
com.github.rvesse.airline.help.sections.HelpSection

Packages that use HelpSection

Package	Description
com.github.rvesse.airline.builder
com.github.rvesse.airline.help.cli
com.github.rvesse.airline.help.common
com.github.rvesse.airline.help.sections.common
com.github.rvesse.airline.help.sections.factories
com.github.rvesse.airline.model
com.github.rvesse.airline.utils.comparators

Uses of HelpSection in com.github.rvesse.airline.builder

Fields in com.github.rvesse.airline.builder with type parameters of type HelpSection

Modifier and Type	Field and Description
protected Map<String,HelpSection>	CliBuilder.baseHelpSections

Methods in com.github.rvesse.airline.builder with parameters of type HelpSection

Modifier and Type	Method and Description
CliBuilder<C>	CliBuilder.withHelpSection(HelpSection section)

Uses of HelpSection in com.github.rvesse.airline.help.cli

Methods in com.github.rvesse.airline.help.cli with parameters of type HelpSection

Modifier and Type	Method and Description
void	CliUsageHelper.outputHelpSection(UsagePrinter out, HelpSection section) Outputs a help section

Uses of HelpSection in com.github.rvesse.airline.help.common

Method parameters in com.github.rvesse.airline.help.common with type arguments of type HelpSection

Modifier and Type	Method and Description
protected void	AbstractCommandUsageGenerator.findHelpSections(CommandMetadata command, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections
protected void	AbstractCommandUsageGenerator.findHelpSections(CommandMetadata command, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections
protected void	AbstractGlobalUsageGenerator.findHelpSections(GlobalMetadata<T> global, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections
protected void	AbstractGlobalUsageGenerator.findHelpSections(GlobalMetadata<T> global, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections

Uses of HelpSection in com.github.rvesse.airline.help.sections.common

Classes in com.github.rvesse.airline.help.sections.common that implement HelpSection

Modifier and Type	Class and Description
class	BasicSection
class	DiscussionSection
class	ExamplesSection
class	ExitCodesSection
class	ProseSection
class	VersionSection

Uses of HelpSection in com.github.rvesse.airline.help.sections.factories

Methods in com.github.rvesse.airline.help.sections.factories that return HelpSection

Modifier and Type	Method and Description
HelpSection	HelpSectionFactory.createSection(Annotation annotation) Tries to create a section from the given annotation
HelpSection	CommonSectionsFactory.createSection(Annotation annotation)
static HelpSection	HelpSectionRegistry.getHelpSection(Class<? extends Annotation> cls, Annotation annotation)

Uses of HelpSection in com.github.rvesse.airline.model

Methods in com.github.rvesse.airline.model that return types with arguments of type HelpSection

Modifier and Type	Method and Description
List<HelpSection>	GlobalMetadata.getBaseHelpSections() Gets the base help sections used by all commands unless specifically overridden by individual commands
List<HelpSection>	CommandMetadata.getHelpSections() Gets the additional help sections
protected static Map<String,HelpSection>	MetadataLoader.loadHelpSections(Class<?> sourceClass, Map<String,HelpSection> baseHelpSections)

Method parameters in com.github.rvesse.airline.model with type arguments of type HelpSection

Modifier and Type	Method and Description
static CommandMetadata	MetadataLoader.loadCommand(Class<?> commandType, Map<String,HelpSection> baseHelpSections) Loads command meta-data
static <T> List<CommandMetadata>	MetadataLoader.loadCommands(Iterable<Class<? extends T>> defaultCommands, Map<String,HelpSection> baseHelpSections) Loads command meta-data
static void	MetadataLoader.loadCommandsIntoGroupsByAnnotation(List<CommandMetadata> allCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String,HelpSection> baseHelpSections)
static <C> GlobalMetadata<C>	MetadataLoader.loadGlobal(String name, String description, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> groups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<C> parserConfig) Loads global meta-data
protected static Map<String,HelpSection>	MetadataLoader.loadHelpSections(Class<?> sourceClass, Map<String,HelpSection> baseHelpSections)

Constructor parameters in com.github.rvesse.airline.model with type arguments of type HelpSection

Constructor and Description
CommandMetadata(String name, String description, boolean hidden, Iterable<OptionMetadata> globalOptions, Iterable<OptionMetadata> groupOptions, Iterable<OptionMetadata> commandOptions, OptionMetadata defaultOption, ArgumentsMetadata arguments, Iterable<Accessor> metadataInjections, Class<?> type, List<String> groupNames, List<Group> groups, List<HelpSection> sections)
GlobalMetadata(String name, String description, Iterable<OptionMetadata> options, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> commandGroups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<T> parserConfig)

Uses of HelpSection in com.github.rvesse.airline.utils.comparators

Methods in com.github.rvesse.airline.utils.comparators with parameters of type HelpSection

Modifier and Type	Method and Description
int	HelpSectionComparator.compare(HelpSection o1, HelpSection o2)