Annotation Type Options
-
@Retention(RUNTIME) @Target(TYPE) public @interface Options
Annotation for a class which has fields or methods with anOption
annotation.
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
deprecatedPrefix
When the prefix needs to be renamed, often it is desirable to maintain the backwards compatibility with the previous config.String
description
An optional text, that describes the current options.String
prefix
An optional prefix for all configuration options of the class annotated with this type.
-
-
-
Element Detail
-
prefix
String prefix
An optional prefix for all configuration options of the class annotated with this type. Prefix and name of the option will be separated by a dot.- Default:
- ""
-
-
-
deprecatedPrefix
String deprecatedPrefix
When the prefix needs to be renamed, often it is desirable to maintain the backwards compatibility with the previous config. In that case, the previous prefix can be moved to the fielddeprecatedPrefix
. Both normal and deprecated prefixes would work, with latter printing the deprecation warning.- Default:
- "<NO_DEPRECATION>"
-
-
-
description
String description
An optional text, that describes the current options.- Default:
- ""
-
-