Lehel44 commented on code in PR #6650:
URL: https://github.com/apache/nifi/pull/6650#discussion_r1022178121
##########
nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java:
##########
@@ -591,6 +606,38 @@ public Builder dependsOn(final PropertyDescriptor
property, final String firstDe
return dependsOn(property, dependentValues);
}
+ /**
+ * Establishes a relationship between this Property and the given
property by declaring that this Property is only relevant if the given Property
has a value equal to one of the given
+ * {@link DescribedValue} arguments.
+ * If this method is called multiple times, each with a different
dependency, then a relationship is established such that this Property is
relevant only if all dependencies are satisfied.
+ *
+ * In the case that this property is NOT considered to be relevant
(meaning that it depends on a property whose value is not specified, or whose
value does not match one of the given
+ * Described Values), the property will not be shown in the
component's configuration in the User Interface. Additionally, this property's
value will not be considered for
+ * validation. That is, if this property is configured with an invalid
value and this property depends on Property Foo, and Property Foo does not have
a value set, then the component
+ * will still be valid, because the value of this property is
irrelevant.
+ *
+ * If the given property is not relevant (because its dependencies are
not satisfied), this property is also considered not to be valid.
+ *
+ * @param property the property that must be set in order for this
property to become relevant
Review Comment:
```suggestion
* @param property the property that must be set in order for this
property to become relevant
```
```suggestion
* @param property the conditional property
```
##########
nifi-api/src/main/java/org/apache/nifi/components/PropertyDescriptor.java:
##########
@@ -591,6 +606,38 @@ public Builder dependsOn(final PropertyDescriptor
property, final String firstDe
return dependsOn(property, dependentValues);
}
+ /**
+ * Establishes a relationship between this Property and the given
property by declaring that this Property is only relevant if the given Property
has a value equal to one of the given
+ * {@link DescribedValue} arguments.
+ * If this method is called multiple times, each with a different
dependency, then a relationship is established such that this Property is
relevant only if all dependencies are satisfied.
+ *
+ * In the case that this property is NOT considered to be relevant
(meaning that it depends on a property whose value is not specified, or whose
value does not match one of the given
+ * Described Values), the property will not be shown in the
component's configuration in the User Interface. Additionally, this property's
value will not be considered for
+ * validation. That is, if this property is configured with an invalid
value and this property depends on Property Foo, and Property Foo does not have
a value set, then the component
+ * will still be valid, because the value of this property is
irrelevant.
+ *
+ * If the given property is not relevant (because its dependencies are
not satisfied), this property is also considered not to be valid.
+ *
+ * @param property the property that must be set in order for this
property to become relevant
+ * @param firstDependentValue the first value for the given property
for which this Property is relevant
Review Comment:
Please update the javadoc in case of renaming the parameters below.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
