java.lang.Object
com.github.rvesse.airline.help.sections.common.BasicHint
com.github.rvesse.airline.help.sections.common.BasicSection
All Implemented Interfaces:
HelpHint, HelpSection
Direct Known Subclasses:
ExamplesSection, ExitCodesSection, ProseSection, RelatedCommandsSection

public class BasicSection extends BasicHint implements HelpSection
  • Field Details

    • title

      private final String title
    • postamble

      private final String postamble
    • order

      private final int order
  • Constructor Details

  • Method Details

    • getTitle

      public String getTitle()
      Description copied from interface: HelpSection
      Gets the title for the section
      Specified by:
      getTitle in interface HelpSection
      Returns:
      Section title
    • getPostamble

      public String getPostamble()
      Description copied from interface: HelpSection
      Gets the post-amble text that should be included at the end of the section
      Specified by:
      getPostamble in interface HelpSection
      Returns:
    • suggestedOrder

      public int suggestedOrder()
      Description copied from interface: HelpSection
      Gets an integer indicating the suggested order that a help generator should include this section in

      A value of zero indicates that the help generator can decide where to place this section, a positive value indicates it should be placed after the default sections while a negative value indicates it should be placed before the default sections. There is however no guarantee that a help generator will honour the order given.

      Specified by:
      suggestedOrder in interface HelpSection
      Returns:
      Suggested order