Skip to content

Commit 1fa87a3

Browse files
committed
Add Javadoc for @org.jgroups.annotations.Property configuration and its idiosyncrasies.
1 parent 73278bf commit 1fa87a3

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

src/org/jgroups/annotations/Property.java

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@
4949

5050
String dependsUpon() default "";
5151

52+
/**
53+
* If the value is not explicitly specified, attempt to fetch the value first from the System property using
54+
* {@link java.lang.System#getProperty(java.lang.String)}, secondly from the environment variable
55+
* {@link java.lang.System#getenv(java.lang.String)} of the given names.
56+
* If all lookups fail, the field will be null.
57+
*/
5258
String[] systemProperty() default {};
5359

5460
/**
@@ -61,10 +67,19 @@
6167
*/
6268
String defaultValueIPv6() default "" ;
6369

64-
/** Expose this property also as a managed attribute */
70+
/**
71+
* Configures whether to expose this property as a managed attribute.
72+
* This is typically used to disable exposing objects that are not well represented as Strings or other primitives
73+
* and security-sensitive configuration.
74+
* Write-only managed attributes are not supported.
75+
*/
6576
boolean exposeAsManagedAttribute() default true;
6677

67-
/* Should this managed attribute be writeable ? If set to true, automatically sets exposeAsManagedAttribute to true */
78+
/**
79+
* Configures whether this managed attribute is writeable at runtime.
80+
* Protocols exposing writeable attributes must ensure that the implementation uses the updated value.
81+
* If set to true, automatically sets exposeAsManagedAttribute to true.
82+
*/
6883
boolean writable() default true;
6984

7085
/** Defines the type, used for pretty printing */

0 commit comments

Comments
 (0)