Skip to content

Commit 02a62fb

Browse files
committed
Minor Javadoc rewording
1 parent de93e7c commit 02a62fb

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

  • server/src/main/java/org/elasticsearch/common/settings

server/src/main/java/org/elasticsearch/common/settings/Setting.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -832,7 +832,8 @@ public interface Validator<T> {
832832
void validate(T value);
833833

834834
/**
835-
* Validate this setting against its dependencies, specified by {@link #settings()}. Default implementation is a no operation.
835+
* Validate this setting against its dependencies, specified by {@link #settings()}. The default implementation does nothing,
836+
* accepting any value as valid as long as it passes the validation in {@link #validate(Object)}.
836837
*
837838
* @param value the value of this setting
838839
* @param settings a map from the settings specified by {@link #settings()}} to their values
@@ -841,9 +842,11 @@ default void validate(T value, Map<Setting<T>, T> settings) {
841842
}
842843

843844
/**
844-
* The settings needed by this validator. Default value is an empty iterator.
845+
* The settings on which the validity of this setting depends. The values of the specified settings are passed to
846+
* {@link #validate(Object, Map)}. By default this returns an empty iterator, indicating that this setting does not depend on any
847+
* other settings.
845848
*
846-
* @return the settings needed to validate; these can be used for cross-settings validation
849+
* @return the settings on which the validity of this setting depends.
847850
*/
848851
default Iterator<Setting<T>> settings() {
849852
return Collections.emptyIterator();

0 commit comments

Comments
 (0)