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

Class BasicHint

  • All Implemented Interfaces:
    HelpHint
    Direct Known Subclasses:
    BasicSection
    public class BasicHint
extends java.lang.Object
implements HelpHint

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<java.lang.String[]> blocks  
      private HelpFormat format  
      private java.lang.String preamble  

    • Constructor Summary

      Constructors 
      Constructor Description
      BasicHint​(java.lang.String preamble, HelpFormat format, java.lang.String[]... blocks)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String[] getContentBlock​(int blockNumber)
      Gets the content block with the given number
      HelpFormat getFormat()
      Gets the format of the provided help information
      java.lang.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

    • Field Detail

      • preamble

        private final java.lang.String preamble

      • blocks

        private java.util.List<java.lang.String[]> blocks

    • Constructor Detail

      • BasicHint

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

    • Method Detail

      • getPreamble

        public java.lang.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 java.lang.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