Annotation Type ExternalProse


  • @Retention(RUNTIME)
    @Target(TYPE)
    public @interface ExternalProse
    Defines a prose section where the prose content is provided in a text file on the classpath
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String source
      Source containing the prose content
      java.lang.String title
      Title of the section
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<? extends ParagraphsParser> parser
      The parser to use to translate the source specified by source() into paragraphs
      java.lang.Class<? extends ResourceLocator>[] sourceLocators
      Resource locators used to find the resources specified in source()
      int suggestedOrder
      Suggested order in which the help section should be placed relative to other help sections
    • Element Detail

      • title

        java.lang.String title
        Title of the section
        Returns:
        Title
      • source

        java.lang.String source
        Source containing the prose content
        Returns:
        Source
      • suggestedOrder

        int suggestedOrder
        Suggested order in which the help section should be placed relative to other help sections

        Values less than zero will typically place the section before the standard sections while values greater than or equal to zero will place the section after the standard sections.

        Returns:
        Suggested order
        Default:
        0
      • sourceLocators

        java.lang.Class<? extends ResourceLocator>[] sourceLocators
        Resource locators used to find the resources specified in source()
        Returns:
        Resource locators to use
        Default:
        {com.github.rvesse.airline.parser.resources.ClasspathLocator.class, com.github.rvesse.airline.parser.resources.ModulePathLocator.class, com.github.rvesse.airline.parser.resources.FileLocator.class}
      • parser

        java.lang.Class<? extends ParagraphsParser> parser
        The parser to use to translate the source specified by source() into paragraphs
        Returns:
        Paragraph parser
        Default:
        com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class