Package uk.ac.starlink.util
Annotation Interface ConfigMethod
Annotation that prepares a mutator method for use and documentation
by the
BeanConfig
class. This annotation is not required
for such configuration, but it can be used to improve documentation
and make usage easier.
This annotation will normally be applied to a bean-setting method
with a signature like void setXxx(type)
.
- Since:
- 25 Sep 2020
- Author:
- Mark Taylor
- See Also:
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionString representation of an example value for this property, suitable for use in documentation.boolean
If true, the setting should not be documented under normal circumstances.int
Gives a sequence index indicating the order in which the different ConfigMethods in a given class should be listed.Usage string.
-
Element Details
-
property
String propertyGives an alternative name for the property defined by this method. If the annotated method is namedsetXxx
and the property value isyyy
, this configuration defined by this method can be addressed as either the propertyxxx
oryyy
.- Returns:
- property name
-
doc
String docUser-directed documentation. The format is not specified here, but if the return value starts with a "<" the content is probably XML, and if it doesn't it's probably plain text.- Returns:
- user-directed documentation
-
-
-
example
String exampleString representation of an example value for this property, suitable for use in documentation.- Returns:
- example setting
- Default:
- ""
-
usage
String usageUsage string. Only required if there is something more to say than the data type.- Returns:
- short user-directed plain text usage string
- Default:
- ""
-
hide
boolean hideIf true, the setting should not be documented under normal circumstances.- Returns:
- true to hide
- Default:
- false
-
sequence
int sequenceGives a sequence index indicating the order in which the different ConfigMethods in a given class should be listed.- Returns:
- sequence index for listing in documentation
- Default:
- 1000
-