Package uk.ac.starlink.util
Annotation Type ConfigMethod
-
@Documented @Inherited @Retention(RUNTIME) @Target(METHOD) public @interface ConfigMethod
Annotation that prepares a mutator method for use and documentation by theBeanConfig
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:
BeanConfig
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String
example
String representation of an example value for this property, suitable for use in documentation.boolean
hide
If true, the setting should not be documented under normal circumstances.int
sequence
Gives a sequence index indicating the order in which the different ConfigMethods in a given class should be listed.java.lang.String
usage
Usage string.
-
-
-
Element Detail
-
property
java.lang.String property
Gives 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
-
-