Skip to content

Commit

Permalink
Merge pull request #853 from rhusar/property-javadoc
Browse files Browse the repository at this point in the history
Add Javadoc for @org.jgroups.annotations.Property configuration and i…
  • Loading branch information
belaban authored Oct 28, 2024
2 parents 5bce11a + 1fa87a3 commit 9c8fbfc
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions src/org/jgroups/annotations/Property.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@

String dependsUpon() default "";

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

/**
Expand All @@ -61,10 +67,19 @@
*/
String defaultValueIPv6() default "" ;

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

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

/** Defines the type, used for pretty printing */
Expand Down

0 comments on commit 9c8fbfc

Please sign in to comment.