Annotation Type ExternalProse
-
@Retention(RUNTIME) @Target(TYPE) public @interface ExternalProse
Defines a prose section where the prose content is provided in a text file on the classpath
-
-
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 bysource()
into paragraphsjava.lang.Class<? extends ResourceLocator>[]
sourceLocators
Resource locators used to find the resources specified insource()
int
suggestedOrder
Suggested order in which the help section should be placed relative to other help sections
-
-
-
-
suggestedOrder
int suggestedOrder
Suggested order in which the help section should be placed relative to other help sectionsValues less than zero will typically place the section before the standard sections while values greater than or equal to zero will place the section after the standard sections.
- Returns:
- Suggested order
- Default:
- 0
-
-
-
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 ParagraphsParser> parser
The parser to use to translate the source specified bysource()
into paragraphs- Returns:
- Paragraph parser
- Default:
- com.github.rvesse.airline.help.external.parsers.defaults.DefaultExternalHelpParser.class
-
-