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
public class BasicSection extends BasicHint implements HelpSection
-
-
Constructor Summary
Constructors Constructor Description BasicSection(java.lang.String title, int suggestedOrder, java.lang.String preamble, java.lang.String postamble, HelpFormat format, java.lang.String[]... blocks)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getPostamble()
Gets the post-amble text that should be included at the end of the sectionjava.lang.String
getTitle()
Gets the title for the sectionint
suggestedOrder()
Gets an integer indicating the suggested order that a help generator should include this section in-
Methods 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
-
-
-
-
Constructor Detail
-
BasicSection
public BasicSection(java.lang.String title, int suggestedOrder, java.lang.String preamble, java.lang.String postamble, HelpFormat format, java.lang.String[]... blocks)
-
-
Method Detail
-
getTitle
public java.lang.String getTitle()
Description copied from interface:HelpSection
Gets the title for the section- Specified by:
getTitle
in interfaceHelpSection
- Returns:
- Section title
-
getPostamble
public java.lang.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 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
-
-