sashapolo commented on a change in pull request #240:
URL: https://github.com/apache/ignite-3/pull/240#discussion_r674936538
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
##########
@@ -19,7 +19,11 @@
import java.util.function.Consumer;
-/** */
+/**
+ * Change closure parameter for the {@link NamedConfigurationTree} instance.
Contains methods to modify named lists.
Review comment:
```suggestion
* Change closure parameter for a {@link NamedConfigurationTree} instance.
Contains methods to modify named lists.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
##########
@@ -19,7 +19,11 @@
import java.util.function.Consumer;
-/** */
+/**
+ * Change closure parameter for the {@link NamedConfigurationTree} instance.
Contains methods to modify named lists.
+ *
+ * @param <Change> Change type for the named list elements.
Review comment:
What is a "Change type"?
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
##########
@@ -32,9 +38,11 @@
* @param key Key string.
* @return Requested value or {@code null} if it's not found.
*/
- T get(String key);
+ View get(String key);
/**
+ * Returns number of elements.
Review comment:
```suggestion
* Returns the number of elements in this list.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/ConfigurationRoot.java
##########
@@ -34,9 +34,17 @@
@Retention(RUNTIME)
@Documented
public @interface ConfigurationRoot {
- /** @return Unique root name. */
+ /**
+ * Returns unique root name.
Review comment:
same stuff about articles
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationContext.java
##########
@@ -25,19 +25,34 @@
/**
* Validation context for the validators.
*
+ * @param <VIEW> Type of the subtree or the value that is being validated.
* @see Validator#validate(Annotation, ValidationContext)
*/
public interface ValidationContext<VIEW> {
- /** @return String representation of currently validated value, i.e.
{@code root.config.node} */
+ /**
+ * Returns key of validated node.
Review comment:
same
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationIssue.java
##########
@@ -18,19 +18,25 @@
import org.apache.ignite.internal.tostring.S;
-/** */
+/**
+ * Class that stores information about issues found during configuration
valudation.
Review comment:
```suggestion
* Class that stores information about issues found during the configuration
validation.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
##########
@@ -19,9 +19,15 @@
import java.util.List;
-/** */
-public interface NamedListView<T> {
+/**
+ * View type for the {@link NamedConfigurationTree}. Represents immutable
snapshot of the named list configuration.
+ *
+ * @param <View> View type for the named list element.
Review comment:
```suggestion
* @param <View> View type for named list elements.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
##########
@@ -19,9 +19,15 @@
import java.util.List;
-/** */
-public interface NamedListView<T> {
+/**
+ * View type for the {@link NamedConfigurationTree}. Represents immutable
snapshot of the named list configuration.
Review comment:
```suggestion
* View type for a {@link NamedConfigurationTree}. Represents an immutable
snapshot of a named list configuration.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java
##########
@@ -46,20 +59,26 @@ public RootKey(Class<?> schemaClass) {
}
/**
+ * Returns name of the configuration tree.
+ *
* @return Name of the configuration root.
*/
public String key() {
return rootName;
}
/**
+ * Returns configuration type of the root.
Review comment:
```suggestion
* Returns the configuration type of the root.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/ConfigurationNotificationEvent.java
##########
@@ -23,24 +23,31 @@
/**
* Event object propogated on configuration change. Passed to listeners after
configuration changes are applied.
*
+ * @param <VIEW> Type of the subtree or the value that has been changed.
* @see ConfigurationProperty#listen(ConfigurationListener)
* @see ConfigurationListener
* @see ConfigurationNotificationEvent
*/
public interface ConfigurationNotificationEvent<VIEW> {
/**
+ * Returns previous value of the updated configuration.
Review comment:
same stuff about articles
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
##########
@@ -31,5 +31,10 @@
@Retention(RUNTIME)
@Documented
public @interface Max {
+ /**
+ * Returns upped bound for the value.
Review comment:
```suggestion
* Returns the upper bound for the value.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
##########
@@ -19,7 +19,11 @@
import java.util.function.Consumer;
-/** */
+/**
+ * Change closure parameter for the {@link NamedConfigurationTree} instance.
Contains methods to modify named lists.
Review comment:
"Change closure parameter" - sound very ambiguous, can you rephrase it
please?
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java
##########
@@ -46,20 +59,26 @@ public RootKey(Class<?> schemaClass) {
}
/**
+ * Returns name of the configuration tree.
+ *
* @return Name of the configuration root.
*/
public String key() {
return rootName;
}
/**
+ * Returns configuration type of the root.
+ *
* @return Configuration type of the root.
*/
public ConfigurationType type() {
return storageType;
}
/**
+ * Returns schema class for the root.
Review comment:
```suggestion
* Returns the schema class for the root.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
##########
@@ -19,7 +19,11 @@
import java.util.function.Consumer;
-/** */
+/**
+ * Change closure parameter for the {@link NamedConfigurationTree} instance.
Contains methods to modify named lists.
+ *
+ * @param <Change> Change type for the named list elements.
Review comment:
```suggestion
* @param <Change> Change type for named list elements.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java
##########
@@ -46,20 +59,26 @@ public RootKey(Class<?> schemaClass) {
}
/**
+ * Returns name of the configuration tree.
Review comment:
```suggestion
* Returns the name of the configuration root.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
##########
@@ -19,9 +19,15 @@
import java.util.List;
-/** */
-public interface NamedListView<T> {
+/**
+ * View type for the {@link NamedConfigurationTree}. Represents immutable
snapshot of the named list configuration.
+ *
+ * @param <View> View type for the named list element.
+ */
+public interface NamedListView<View> {
/**
+ * Returns immutable collection of keys contained within this list.
Review comment:
```suggestion
* Returns an immutable collection of keys contained within this list.
```
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
##########
@@ -19,9 +19,15 @@
import java.util.List;
-/** */
-public interface NamedListView<T> {
+/**
+ * View type for the {@link NamedConfigurationTree}. Represents immutable
snapshot of the named list configuration.
+ *
+ * @param <View> View type for the named list element.
Review comment:
What is a "View type"?
##########
File path:
modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
##########
@@ -31,5 +31,10 @@
@Retention(RUNTIME)
@Documented
public @interface Min {
+ /**
+ * Returns lower bound for the value.
Review comment:
```suggestion
* Returns the lower bound for the value.
```
--
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]
