Annotation 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 -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionClass
<? extends TabularParser> The parser to use to translate the source specified bysource()
into tabular dataClass<? extends ResourceLocator>[]
Resource locators used to find the resources specified insource()
-
Element Details
-
source
String sourceSource containing the examples and their descriptions in tabular format- Returns:
- Source
-
sourceLocators
Class<? extends ResourceLocator>[] sourceLocatorsResource locators used to find the resources specified insource()
- 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> parserThe parser to use to translate the source specified bysource()
into tabular data- Returns:
- Tabular parser
- Default:
com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class
-