Uses of Interface
com.github.rvesse.airline.help.sections.HelpSection
-
-
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 Description protected java.util.Map<java.lang.String,HelpSection>
CliBuilder. baseHelpSections
Methods in com.github.rvesse.airline.builder with parameters of type HelpSection Modifier and Type Method Description CliBuilder<C>
CliBuilder. withHelpSection(HelpSection section)
-
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 HelpSection Modifier and Type Class Description class
RelatedCommandsSection
Methods in com.github.rvesse.airline.examples.userguide.help.sections.custom that return HelpSection Modifier and Type Method Description HelpSection
RelatedCommandsFactory. createSection(java.lang.annotation.Annotation annotation)
-
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 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 Description protected void
AbstractCommandUsageGenerator. findHelpSections(CommandMetadata command, java.util.List<HelpSection> preSections, java.util.List<HelpSection> postSections)
Finds the help sectionsprotected void
AbstractGlobalUsageGenerator. findHelpSections(GlobalMetadata<T> global, java.util.List<HelpSection> preSections, java.util.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 Modifier and Type Method Description HelpSection
ExternalHelpFactory. createSection(java.lang.annotation.Annotation annotation)
-
Uses of HelpSection in com.github.rvesse.airline.help.html
Methods in com.github.rvesse.airline.help.html with parameters of type HelpSection Modifier and Type Method Description protected void
HtmlCommandUsageGenerator. outputHelpSection(java.io.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 HelpSection Modifier and Type Method Description void
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 HelpSection Modifier and Type Method Description void
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 HelpSection Modifier and Type Class 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 Description HelpSection
CommonSectionsFactory. createSection(java.lang.annotation.Annotation annotation)
HelpSection
HelpSectionFactory. createSection(java.lang.annotation.Annotation annotation)
Tries to create a section from the given annotationstatic HelpSection
HelpSectionRegistry. getHelpSection(java.lang.Class<? extends java.lang.annotation.Annotation> cls, java.lang.annotation.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 HelpSection Modifier and Type Field Description private java.util.List<HelpSection>
GlobalMetadata. baseHelpSections
private java.util.List<HelpSection>
CommandMetadata. sections
Methods in com.github.rvesse.airline.model that return types with arguments of type HelpSection Modifier and Type Method Description java.util.List<HelpSection>
GlobalMetadata. getBaseHelpSections()
Gets the base help sections used by all commands unless specifically overridden by individual commandsjava.util.List<HelpSection>
CommandMetadata. getHelpSections()
Gets the additional help sectionsprotected static java.util.Map<java.lang.String,HelpSection>
MetadataLoader. loadHelpSections(java.lang.Class<?> sourceClass, java.util.Map<java.lang.String,HelpSection> baseHelpSections)
Method parameters in com.github.rvesse.airline.model with type arguments of type HelpSection Modifier and Type Method Description private static void
MetadataLoader. createGroupsFromAnnotations(java.util.List<CommandMetadata> allCommands, java.util.List<CommandMetadata> newCommands, java.util.List<CommandGroupMetadata> commandGroups, java.util.List<CommandMetadata> defaultCommandGroup, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
static CommandMetadata
MetadataLoader. loadCommand(java.lang.Class<?> commandType, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
Loads command meta-datastatic <T> java.util.List<CommandMetadata>
MetadataLoader. loadCommands(java.lang.Iterable<java.lang.Class<? extends T>> defaultCommands, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
Loads command meta-datastatic void
MetadataLoader. loadCommandsIntoGroupsByAnnotation(java.util.List<CommandMetadata> allCommands, java.util.List<CommandGroupMetadata> commandGroups, java.util.List<CommandMetadata> defaultCommandGroup, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
protected static java.util.Map<java.lang.String,HelpSection>
MetadataLoader. loadHelpSections(java.lang.Class<?> sourceClass, java.util.Map<java.lang.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 HelpSection Modifier and Type Method Description int
HelpSectionComparator. compare(HelpSection o1, HelpSection o2)
-