Modifier and Type | Required Element and Description |
---|---|
String[] |
sources
Sets paths to resources that provide the version information
|
boolean |
suppressOnError
Sets whether to suppress this help section if there is an error obtaining
the version information.
|
Modifier and Type | Optional Element and Description |
---|---|
String[] |
additionalProperties |
String[] |
additionalTitles |
String |
buildProperty |
String |
componentProperty |
String |
dateProperty |
boolean |
tabular
Whether to display the version information in a tabular format
|
String |
versionProperty |
public abstract String[] sources
When 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. Paths are scanned for both on the classpath and on the
local file system, if a path identifies both then the classpath source is
used and the file system source is ignored. If you want to force a file
system path to be used then you can prepend the path with file://
Each 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.
public abstract boolean suppressOnError
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 to true
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.
public abstract String componentProperty
public abstract String versionProperty
public abstract String buildProperty
public abstract String dateProperty
public abstract String[] additionalProperties
public abstract String[] additionalTitles
public abstract boolean tabular
Copyright © 2012–2017. All rights reserved.