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

    Modifier and Type
    Method
    Description
    getContentBlock(int blockNumber)
    Gets the content block with the given number
    Gets the format of the provided help information
    Gets the preamble text that should be included
    int
    Gets the number of content blocks provided
  • Method Details

    • getPreamble

      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 provided

      Help 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

      String[] getContentBlock(int blockNumber)
      Gets the content block with the given number
      Parameters:
      blockNumber - Block number
      Returns:
      Content Block