Annotation Interface ExternalExamples

@Retention(RUNTIME) @Target(TYPE) @Documented public @interface ExternalExamples
Annotation that provides an examples section for a commands help via two external resources in textual format

  • Element Details

    • exampleSource

      String exampleSource
      Source containing the examples
      Returns:
      Example source

    • descriptionSource

      String descriptionSource
      Source containing the descriptions of the examples
      Returns:
      Description source

    • sourceLocators

      Class<? extends ResourceLocator>[] sourceLocators
      Resource locators used to find the resources specified in exampleSource() and descriptionSource()
      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 exampleSource() and descriptionSource() into paragraphs
      Returns:
      Paragraphs parser
      Default:
      com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class