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

Class BasicHint

java.lang.Object

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

All Implemented Interfaces:

HelpHint

Direct Known Subclasses:

BasicSection

public class BasicHint
extends Object
implements HelpHint

Constructor Summary

Constructors

Constructor and Description
BasicHint(String preamble, HelpFormat format, String[]... blocks)

Method Summary

Modifier and Type	Method and Description
String[]	getContentBlock(int blockNumber) Gets the content block with the given number
HelpFormat	getFormat() Gets the format of the provided help information
String	getPreamble() Gets the preamble text that should be included
int	numContentBlocks() Gets the number of content blocks provided

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicHint

public BasicHint(String preamble,
                 HelpFormat format,
                 String[]... blocks)

Method Detail

getPreamble

public String getPreamble()

Description copied from interface: HelpHint

Gets the preamble text that should be included

Specified by:

getPreamble in interface HelpHint

Returns:

Preamble text

getFormat

public HelpFormat getFormat()

Description copied from interface: HelpHint

Gets the format of the provided help information

Specified by:

getFormat in interface HelpHint

Returns:

Help format

numContentBlocks

public int numContentBlocks()

Description copied from interface: HelpHint

Gets the number of content blocks provided

Help generators should consult the HelpHint.getFormat() return value to determine how to format the content blocks but they are not required to do so

Specified by:

numContentBlocks in interface HelpHint

Returns:

Number of content blocks

getContentBlock

public String[] getContentBlock(int blockNumber)

Description copied from interface: HelpHint

Gets the content block with the given number

Specified by:

getContentBlock in interface HelpHint

Parameters:

blockNumber - Block number

Returns:

Content Block