com.github.rvesse.airline.help.sections.common

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

public class BasicSection
extends BasicHint
implements HelpSection

Constructor Summary

Constructors

Constructor and Description
BasicSection(String title, int suggestedOrder, String preamble, String postamble, HelpFormat format, String[]... blocks)

Method Summary

Modifier and Type	Method and Description
String	getPostamble() Gets the post-amble text that should be included at the end of the section
String	getTitle() Gets the title for the section
int	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(String title,
                    int suggestedOrder,
                    String preamble,
                    String postamble,
                    HelpFormat format,
                    String[]... blocks)

Method Detail

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