Annotation Interface ExternalDiscussion

@Retention(RUNTIME) @Target(TYPE) public @interface ExternalDiscussion
Defines a discussion section where the discussion content is provided in a text file on the classpath

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    source
    Source containing the discussion content

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends ParagraphsParser>
    parser
    The parser to use to translate the source specified by source() into paragraphs
    Class<? extends ResourceLocator>[]
    sourceLocators
    Resource locators used to find the resources specified in source()

  • Element Details

    • source

      String source
      Source containing the discussion content
      Returns:
      Source

    • 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