Module com.github.rvesse.airline
Interface HelpSection
- All Superinterfaces:
HelpHint
- All Known Implementing Classes:
BasicSection
,DiscussionSection
,ExamplesSection
,ExitCodesSection
,ProseSection
,RelatedCommandsSection
,VersionSection
Interface for classes that represents additional help sections
-
Method Summary
Modifier and TypeMethodDescriptionGets the post-amble text that should be included at the end of the sectiongetTitle()
Gets the title for the sectionint
Gets an integer indicating the suggested order that a help generator should include this section inMethods inherited from interface com.github.rvesse.airline.help.sections.HelpHint
getContentBlock, getFormat, getPreamble, numContentBlocks
-
Method Details
-
getTitle
String getTitle()Gets the title for the section- Returns:
- Section title
-
getPostamble
String getPostamble()Gets the post-amble text that should be included at the end of the section- Returns:
-
suggestedOrder
int suggestedOrder()Gets an integer indicating the suggested order that a help generator should include this section inA 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.
- Returns:
- Suggested order
-