Annotation Interface ExternalTabularExamples


@Retention(RUNTIME) @Target(TYPE) @Documented public @interface ExternalTabularExamples
Annotation that provides an examples section for a commands help via a single external resource in tabular format
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Source containing the examples and their descriptions in tabular format
  • Optional Element Summary

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

    • source

      String source
      Source containing the examples and their descriptions in tabular format
      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 TabularParser> parser
      The parser to use to translate the source specified by source() into tabular data
      Returns:
      Tabular parser
      Default:
      com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class