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

Class VersionSection

    • Constructor Summary

      Constructors 
      Constructor Description
      VersionSection​(java.lang.String[] dataSources, ResourceLocator[] resourceLocators, java.lang.String componentProperty, java.lang.String versionProperty, java.lang.String buildProperty, java.lang.String dateProperty, java.lang.String[] additionalProperties, java.lang.String[] additionalTitles, boolean suppressErrors, boolean tabular)  

    • 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 getPostamble()
      Gets the post-amble text that should be included at the end of the section
      java.lang.String getPreamble()
      Gets the preamble text that should be included
      java.lang.String getTitle()
      Gets the title for the section
      private java.util.Properties loadDataSource​(ResourceLocator[] resourceLocators, java.lang.String source)  
      int numContentBlocks()
      Gets the number of content blocks provided
      private void sourceNotFound​(java.lang.String dataSource)  
      int suggestedOrder()
      Gets an integer indicating the suggested order that a help generator should include this section in

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • tabular

        private final boolean tabular

      • titles

        private final java.lang.String[] titles

    • Constructor Detail

      • VersionSection

        public VersionSection​(java.lang.String[] dataSources,
                      ResourceLocator[] resourceLocators,
                      java.lang.String componentProperty,
                      java.lang.String versionProperty,
                      java.lang.String buildProperty,
                      java.lang.String dateProperty,
                      java.lang.String[] additionalProperties,
                      java.lang.String[] additionalTitles,
                      boolean suppressErrors,
                      boolean tabular)

    • Method Detail

      • sourceNotFound

        private void sourceNotFound​(java.lang.String dataSource)

      • loadDataSource

        private java.util.Properties loadDataSource​(ResourceLocator[] resourceLocators,
                                            java.lang.String source)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • 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

      • getTitle

        public java.lang.String getTitle()
        Description copied from interface: HelpSection
        Gets the title for the section
        Specified by:
        getTitle in interface HelpSection
        Returns:
        Section title

      • getPostamble

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