Uses of Interface
com.github.rvesse.airline.help.sections.HelpSection
Packages that use HelpSection
Package
Description
-
Uses of HelpSection in com.github.rvesse.airline.builder
Fields in com.github.rvesse.airline.builder with type parameters of type HelpSectionModifier and TypeFieldDescriptionprotected final Map
<String, HelpSection> CliBuilder.baseHelpSections
Methods in com.github.rvesse.airline.builder with parameters of type HelpSection -
Uses of HelpSection in com.github.rvesse.airline.examples.userguide.help.sections.custom
Classes in com.github.rvesse.airline.examples.userguide.help.sections.custom that implement HelpSectionMethods in com.github.rvesse.airline.examples.userguide.help.sections.custom that return HelpSection -
Uses of HelpSection in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type HelpSectionModifier and TypeMethodDescriptionvoid
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 HelpSectionModifier and TypeMethodDescriptionprotected void
AbstractCommandUsageGenerator.findHelpSections
(CommandMetadata command, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sectionsprotected 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.external.factories
Methods in com.github.rvesse.airline.help.external.factories that return HelpSection -
Uses of HelpSection in com.github.rvesse.airline.help.html
Methods in com.github.rvesse.airline.help.html with parameters of type HelpSectionModifier and TypeMethodDescriptionprotected void
HtmlCommandUsageGenerator.outputHelpSection
(Writer writer, HelpSection section) Outputs a help section -
Uses of HelpSection in com.github.rvesse.airline.help.man
Methods in com.github.rvesse.airline.help.man with parameters of type HelpSectionModifier and TypeMethodDescriptionvoid
ManUsageHelper.outputHelpSection
(TroffPrinter printer, HelpSection section) Outputs a help section -
Uses of HelpSection in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown with parameters of type HelpSectionModifier and TypeMethodDescriptionvoid
MarkdownUsageHelper.outputHelpSection
(UsagePrinter out, HelpSection section) Outputs a help section -
Uses of HelpSection in com.github.rvesse.airline.help.sections.common
Classes in com.github.rvesse.airline.help.sections.common that implement HelpSectionModifier and TypeClassDescriptionclass
class
class
class
class
class
-
Uses of HelpSection in com.github.rvesse.airline.help.sections.factories
Methods in com.github.rvesse.airline.help.sections.factories that return HelpSectionModifier and TypeMethodDescriptionCommonSectionsFactory.createSection
(Annotation annotation) HelpSectionFactory.createSection
(Annotation annotation) Tries to create a section from the given annotationstatic HelpSection
HelpSectionRegistry.getHelpSection
(Class<? extends Annotation> cls, Annotation annotation) Given an annotation returns a help section if the annotation can be translated into one by any of the registered factories -
Uses of HelpSection in com.github.rvesse.airline.model
Fields in com.github.rvesse.airline.model with type parameters of type HelpSectionModifier and TypeFieldDescriptionprivate final List
<HelpSection> GlobalMetadata.baseHelpSections
private final List
<HelpSection> CommandMetadata.sections
Methods in com.github.rvesse.airline.model that return types with arguments of type HelpSectionModifier and TypeMethodDescriptionGlobalMetadata.getBaseHelpSections()
Gets the base help sections used by all commands unless specifically overridden by individual commandsCommandMetadata.getHelpSections()
Gets the additional help sectionsprotected 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 HelpSectionModifier and TypeMethodDescriptionprivate static void
MetadataLoader.createGroupsFromAnnotations
(List<CommandMetadata> allCommands, List<CommandMetadata> newCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) static CommandMetadata
MetadataLoader.loadCommand
(Class<?> commandType, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) Loads command meta-datastatic <T> List
<CommandMetadata> MetadataLoader.loadCommands
(Iterable<Class<? extends T>> defaultCommands, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) Loads command meta-datastatic void
MetadataLoader.loadCommandsIntoGroupsByAnnotation
(List<CommandMetadata> allCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) protected static Map
<String, HelpSection> MetadataLoader.loadHelpSections
(Class<?> sourceClass, Map<String, HelpSection> baseHelpSections) -
Uses of HelpSection in com.github.rvesse.airline.utils.comparators
Methods in com.github.rvesse.airline.utils.comparators with parameters of type HelpSectionModifier and TypeMethodDescriptionint
HelpSectionComparator.compare
(HelpSection o1, HelpSection o2)