-
- All Known Subinterfaces:
HelpSection
- All Known Implementing Classes:
AbstractAllowedValuesRestriction
,AllowedEnumValuesRestriction
,AllowedRawValuesRestriction
,AllowedValuesRestriction
,BasicHint
,BasicSection
,DiscussionSection
,EndsWithRestriction
,ExamplesSection
,ExitCodesSection
,LengthRestriction
,MultipleOfRestriction
,MutuallyExclusiveRestriction
,NoOptionLikeValuesRestriction
,NotBlankRestriction
,NotEmptyRestriction
,OccurrencesRestriction
,PartialRestriction
,PathRestriction
,PatternRestriction
,PortRestriction
,PositiveNegativeRestriction
,ProseSection
,RangeRestriction
,RelatedCommandsSection
,RequiredOnlyIfRestriction
,RequiredUnlessEnvironmentRestriction
,RequireFromRestriction
,StartsWithRestriction
,VersionSection
public interface HelpHint
Interface for classes that provide additional help information
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]
getContentBlock(int blockNumber)
Gets the content block with the given numberHelpFormat
getFormat()
Gets the format of the provided help informationjava.lang.String
getPreamble()
Gets the preamble text that should be includedint
numContentBlocks()
Gets the number of content blocks provided
-
-
-
Method Detail
-
getPreamble
java.lang.String getPreamble()
Gets the preamble text that should be included- Returns:
- Preamble text
-
getFormat
HelpFormat getFormat()
Gets the format of the provided help information- Returns:
- Help format
-
numContentBlocks
int numContentBlocks()
Gets the number of content blocks providedHelp generators should consult the
getFormat()
return value to determine how to format the content blocks but they are not required to do so- Returns:
- Number of content blocks
-
getContentBlock
java.lang.String[] getContentBlock(int blockNumber)
Gets the content block with the given number- Parameters:
blockNumber
- Block number- Returns:
- Content Block
-
-