Annotation Type Version
-
@Retention(RUNTIME) @Target(TYPE) public @interface Version
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.String[]
sources
Sets paths to resources that provide the version informationboolean
suppressOnError
Sets whether to suppress this help section if there is an error obtaining the version information.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String[]
additionalProperties
Any additional properties from which information should be obtainedjava.lang.String[]
additionalTitles
The titles for the additional properties specified byadditionalProperties()
used to present this information in generated help outputjava.lang.String
buildProperty
Sets the property used to find build information (if any)java.lang.String
componentProperty
Sets the property used to find the component information (if any)java.lang.String
dateProperty
Sets the property used to find build date information (if any)java.lang.Class<? extends ResourceLocator>[]
sourceLocators
Resource locators used to find the properties files specified insources()
boolean
tabular
Whether to display the version information in a tabular formatjava.lang.String
versionProperty
Sets the property used to find version information (if any)
-
-
-
Element Detail
-
sources
java.lang.String[] sources
Sets paths to resources that provide the version informationWhen this annotation is converted into a help section these are the files that are scanned for the version information used to produce the Version help section. Files are located using the resource locators specified by
sourceLocators()
which by default looks for resources on the classpath then as files. You can add the prefixesclasspath:
orfile://
to your source paths to force a specific location to be usedEach source will be provided as a separate list/table row within the help section depending on the setting of the
tabular()
field.Sources are loaded using
Properties.load(java.io.InputStream)
which supports either normal Java properties format (key value pairs separated by=
with one per line) or Java Manifest files.- Returns:
- Sources for version information
-
-
-
suppressOnError
boolean suppressOnError
Sets whether to suppress this help section if there is an error obtaining the version information.When set to
false
a runtime error will be thrown if this annotation is used and the version information cannot be successfully obtained. When set totrue
then if the version information cannot be obtained the help section will either be suppressed if no information was found or if some information was found then partial information is shown.- Returns:
- True if errors in obtaining version information are suppressed
-
-
-
additionalTitles
java.lang.String[] additionalTitles
The titles for the additional properties specified byadditionalProperties()
used to present this information in generated help output- Returns:
- Additional titles
- Default:
- {}
-
-
-
sourceLocators
java.lang.Class<? extends ResourceLocator>[] sourceLocators
Resource locators used to find the properties files specified insources()
- 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}
-
-