Annotation Type 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 java.lang.String
source
Source containing the examples and their descriptions in tabular format
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.Class<? extends TabularParser>
parser
The parser to use to translate the source specified bysource()
into tabular datajava.lang.Class<? extends ResourceLocator>[]
sourceLocators
Resource locators used to find the resources specified insource()
-
-
-
-
sourceLocators
java.lang.Class<? extends ResourceLocator>[] sourceLocators
Resource 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
java.lang.Class<? extends TabularParser> parser
The 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
-
-