@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
    Source containing the prose content
    Title of the section
  • Optional Element Summary

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

    • title

      String title
      Title of the section
      Returns:
      Title
    • source

      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

      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

      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