Annotation Type 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
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.String
descriptionSource
Source containing the descriptions of the examplesjava.lang.String
exampleSource
Source containing the examples
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.Class<? extends ParagraphsParser>
parser
The parser to use to translate the source specified byexampleSource()
anddescriptionSource()
into paragraphsjava.lang.Class<? extends ResourceLocator>[]
sourceLocators
Resource locators used to find the resources specified inexampleSource()
anddescriptionSource()
-
-
-
-
sourceLocators
java.lang.Class<? extends ResourceLocator>[] sourceLocators
Resource locators used to find the resources specified inexampleSource()
anddescriptionSource()
- 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 ParagraphsParser> parser
The parser to use to translate the source specified byexampleSource()
anddescriptionSource()
into paragraphs- Returns:
- Paragraphs parser
- Default:
- com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class
-
-