Module com.github.rvesse.airline
Class BasicSection
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
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionBasicSection
(String title, int suggestedOrder, String preamble, String postamble, HelpFormat format, String[]... blocks) -
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 class com.github.rvesse.airline.help.sections.common.BasicHint
getContentBlock, getFormat, getPreamble, numContentBlocks
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.github.rvesse.airline.help.sections.HelpHint
getContentBlock, getFormat, getPreamble, numContentBlocks
-
Field Details
-
title
-
postamble
-
order
private final int order
-
-
Constructor Details
-
BasicSection
public BasicSection(String title, int suggestedOrder, String preamble, String postamble, HelpFormat format, String[]... blocks)
-
-
Method Details
-
getTitle
Description copied from interface:HelpSection
Gets the title for the section- Specified by:
getTitle
in interfaceHelpSection
- Returns:
- Section title
-
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 interfaceHelpSection
- 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 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.
- Specified by:
suggestedOrder
in interfaceHelpSection
- Returns:
- Suggested order
-