Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Javadoc for @org.jgroups.annotations.Property configuration and i… #853

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Add Javadoc for @org.jgroups.annotations.Property configuration and i… #853

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/org/jgroups/annotations/Property.java
View file
Open in desktop
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