You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by ib...@apache.org on 2021/07/23 09:07:10 UTC
[ignite-3] branch main updated: IGNITE-15149 Javadoc fixes for
configuration-api module. (#240)
This is an automated email from the ASF dual-hosted git repository.
ibessonov pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new d13b2e2 IGNITE-15149 Javadoc fixes for configuration-api module. (#240)
d13b2e2 is described below
commit d13b2e290ff5701bb1cadf82afd06a6dfd61148c
Author: ibessonov <be...@gmail.com>
AuthorDate: Fri Jul 23 12:07:04 2021 +0300
IGNITE-15149 Javadoc fixes for configuration-api module. (#240)
---
check-rules/checkstyle-disabled-modules.xml | 1 -
.../ConfigurationChangeException.java | 2 ++
.../configuration/ConfigurationProperty.java | 4 ++++
.../ignite/configuration/ConfigurationTree.java | 3 +++
.../ignite/configuration/ConfigurationValue.java | 1 +
.../configuration/NamedConfigurationTree.java | 2 ++
.../ignite/configuration/NamedListChange.java | 6 ++++-
.../apache/ignite/configuration/NamedListView.java | 14 ++++++++---
.../org/apache/ignite/configuration/RootKey.java | 27 ++++++++++++++++++----
.../annotation/ConfigurationRoot.java | 12 ++++++++--
.../ignite/configuration/annotation/Value.java | 1 +
.../Min.java => annotation/package-info.java} | 18 ++-------------
.../ConfigurationNotificationEvent.java | 9 +++++++-
.../Max.java => notifications/package-info.java} | 18 ++-------------
.../{validation/Max.java => package-info.java} | 18 ++-------------
.../ConfigurationValidationException.java | 11 +++++++++
.../ignite/configuration/validation/Max.java | 5 ++++
.../ignite/configuration/validation/Min.java | 5 ++++
.../validation/ValidationContext.java | 23 +++++++++++++++---
.../configuration/validation/ValidationIssue.java | 10 ++++++--
.../validation/{Min.java => package-info.java} | 18 ++-------------
21 files changed, 127 insertions(+), 81 deletions(-)
diff --git a/check-rules/checkstyle-disabled-modules.xml b/check-rules/checkstyle-disabled-modules.xml
index 117bdad..4effe67 100644
--- a/check-rules/checkstyle-disabled-modules.xml
+++ b/check-rules/checkstyle-disabled-modules.xml
@@ -25,7 +25,6 @@
<suppressions>
<suppress files="[/\\]examples[/\\]" checks=".*" />
<suppress files="[/\\]modules/cli[/\\]" checks=".*" />
- <suppress files="[/\\]modules/configuration-api[/\\]" checks=".*" />
<suppress files="[/\\]modules/raft-client[/\\]" checks=".*" />
<suppress files="[/\\]modules/network[/\\]" checks=".*" />
<suppress files="[/\\]modules/network-api[/\\]" checks=".*" />
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationChangeException.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationChangeException.java
index e9c2097..4449a15 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationChangeException.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationChangeException.java
@@ -22,6 +22,7 @@ package org.apache.ignite.configuration;
public class ConfigurationChangeException extends RuntimeException {
/**
* Constructor.
+ *
* @param message Error message.
*/
public ConfigurationChangeException(String message) {
@@ -30,6 +31,7 @@ public class ConfigurationChangeException extends RuntimeException {
/**
* Constructor.
+ *
* @param message Error message.
* @param cause Cause.
*/
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationProperty.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationProperty.java
index f1a6729..da0e5b7 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationProperty.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationProperty.java
@@ -21,24 +21,28 @@ import org.apache.ignite.configuration.notifications.ConfigurationListener;
/**
* Base interface for configuration.
+ *
* @param <VIEW> Type of the value.
* @param <CHANGE> Type of the object that changes the value of configuration.
*/
public interface ConfigurationProperty<VIEW, CHANGE> {
/**
* Get key of this node.
+ *
* @return Key.
*/
String key();
/**
* Get value of this property.
+ *
* @return Value of this property.
*/
VIEW value();
/**
* Add configuration values listener.
+ *
* @param listener Listener.
*/
void listen(ConfigurationListener<VIEW> listener);
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationTree.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationTree.java
index 60c7394..0b7cbab 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationTree.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationTree.java
@@ -23,18 +23,21 @@ import java.util.function.Consumer;
/**
* Configuration tree with configuration values and other configuration trees as child nodes.
+ *
* @param <VIEW> Value type of the node.
* @param <CHANGE> Type of the object that changes this node's value.
*/
public interface ConfigurationTree<VIEW, CHANGE> extends ConfigurationProperty<VIEW, CHANGE> {
/**
* Children of the tree.
+ *
* @return Map from {@code String} to a corresponding {@link ConfigurationProperty}.
*/
Map<String, ConfigurationProperty<?, ?>> members();
/**
* Changes this configuration node value.
+ *
* @param change CHANGE object.
* @return Future that is completed when configuration change is finished either successfully or not.
*/
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationValue.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationValue.java
index 1e19d4f..bd70cb1 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationValue.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationValue.java
@@ -22,6 +22,7 @@ import org.apache.ignite.configuration.validation.ConfigurationValidationExcepti
/**
* Configuration value.
+ *
* @param <VIEW> Type of the value.
*/
public interface ConfigurationValue<VIEW> extends ConfigurationProperty<VIEW, VIEW> {
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedConfigurationTree.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedConfigurationTree.java
index 7bf9021..70a48ad 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedConfigurationTree.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedConfigurationTree.java
@@ -31,6 +31,7 @@ public interface NamedConfigurationTree<T extends ConfigurationProperty<VIEW, CH
{
/**
* Get named configuration by name.
+ *
* @param name Name.
* @return Configuration.
*/
@@ -38,6 +39,7 @@ public interface NamedConfigurationTree<T extends ConfigurationProperty<VIEW, CH
/**
* Add named-list-specific configuration values listener.
+ *
* @param listener Listener.
*/
void listen(ConfigurationNamedListListener<VIEW> listener);
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
index a6f8405..3371295 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListChange.java
@@ -19,7 +19,11 @@ package org.apache.ignite.configuration;
import java.util.function.Consumer;
-/** */
+/**
+ * Closure parameter for {@link NamedConfigurationTree#change(Consumer)} method. Contains methods to modify named lists.
+ *
+ * @param <Change> Type for changing named list elements of this particular list.
+ */
public interface NamedListChange<Change> extends NamedListView<Change> {
/**
* Creates a new value in the named list configuration.
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
index 1e1c0ea..60d8e9c 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/NamedListView.java
@@ -19,9 +19,15 @@ package org.apache.ignite.configuration;
import java.util.List;
-/** */
-public interface NamedListView<T> {
+/**
+ * View type for a {@link NamedConfigurationTree}. Represents an immutable snapshot of a named list configuration.
+ *
+ * @param <View> Type for immutable snapshots of named list elements.
+ */
+public interface NamedListView<View> {
/**
+ * Returns an immutable collection of keys contained within this list.
+ *
* @return Immutable collection of keys contained within this list.
*/
List<String> namedListKeys();
@@ -32,9 +38,11 @@ public interface NamedListView<T> {
* @param key Key string.
* @return Requested value or {@code null} if it's not found.
*/
- T get(String key);
+ View get(String key);
/**
+ * Returns the number of elements in this list.
+ *
* @return Number of elements.
*/
int size();
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java
index b11afe9..93ec620 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/RootKey.java
@@ -20,18 +20,31 @@ package org.apache.ignite.configuration;
import org.apache.ignite.configuration.annotation.ConfigurationRoot;
import org.apache.ignite.configuration.annotation.ConfigurationType;
-/** */
+/**
+ * Configuration root selector.
+ *
+ * @param <T> Type of the configuration tree described by the root key.
+ * @param <VIEW> Type of the immutable snapshot view associated with the tree.
+ */
public class RootKey<T extends ConfigurationTree<VIEW, ?>, VIEW> {
- /** */
+ /**
+ * Name of the configuration root.
+ */
private final String rootName;
- /** */
+ /**
+ * Configuration type of the root.
+ */
private final ConfigurationType storageType;
- /** */
+ /**
+ * Schema class for the root.
+ */
private final Class<?> schemaClass;
/**
+ * Constructor.
+ *
* @param schemaClass Class of the configuration schema.
*/
public RootKey(Class<?> schemaClass) {
@@ -46,6 +59,8 @@ public class RootKey<T extends ConfigurationTree<VIEW, ?>, VIEW> {
}
/**
+ * Returns the name of the configuration root.
+ *
* @return Name of the configuration root.
*/
public String key() {
@@ -53,6 +68,8 @@ public class RootKey<T extends ConfigurationTree<VIEW, ?>, VIEW> {
}
/**
+ * Returns the configuration type of the root.
+ *
* @return Configuration type of the root.
*/
public ConfigurationType type() {
@@ -60,6 +77,8 @@ public class RootKey<T extends ConfigurationTree<VIEW, ?>, VIEW> {
}
/**
+ * Returns the schema class for the root.
+ *
* @return Schema class for the root.
*/
public Class<?> schemaClass() {
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/ConfigurationRoot.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/ConfigurationRoot.java
index faf01af..cf55bb3 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/ConfigurationRoot.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/ConfigurationRoot.java
@@ -34,9 +34,17 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Retention(RUNTIME)
@Documented
public @interface ConfigurationRoot {
- /** @return Unique root name. */
+ /**
+ * Returns the unique root name.
+ *
+ * @return Unique root name.
+ */
String rootName();
- /** @return Type of the configuration. */
+ /**
+ * Returns the type of the configuration.
+ *
+ * @return Type of the configuration.
+ */
ConfigurationType type() default ConfigurationType.LOCAL;
}
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/Value.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/Value.java
index c53190d..4c471fd 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/Value.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/Value.java
@@ -45,6 +45,7 @@ public @interface Value {
/**
* Indicates that the current configuration value has a default value. Value itself is derived from the instantiated object
* of a corresponding schema type. This means that the default is not necessarily a constant value.
+ *
* @return {@code hasDefault} flag value.
*/
boolean hasDefault() default false;
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/package-info.java
similarity index 65%
copy from modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
copy to modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/package-info.java
index 97e984d..08e62ae 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/annotation/package-info.java
@@ -15,21 +15,7 @@
* limitations under the License.
*/
-package org.apache.ignite.configuration.validation;
-
-import java.lang.annotation.Documented;
-import java.lang.annotation.Retention;
-import java.lang.annotation.Target;
-
-import static java.lang.annotation.ElementType.FIELD;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
-
/**
- * Signifies that this value has lower limit (exclusive).
+ * Annotations for configuration schemas.
*/
-@Target(FIELD)
-@Retention(RUNTIME)
-@Documented
-public @interface Min {
- long value();
-}
+package org.apache.ignite.configuration.annotation;
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/ConfigurationNotificationEvent.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/ConfigurationNotificationEvent.java
index 4e432d6..77f4a8a 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/ConfigurationNotificationEvent.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/ConfigurationNotificationEvent.java
@@ -23,24 +23,31 @@ import org.jetbrains.annotations.Nullable;
/**
* 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 the previous value of the updated configuration.
+ *
* @return Previous value of the updated configuration.
*/
@Nullable VIEW oldValue();
/**
+ * Returns updated value of the configuration.
+ *
* @return Updated value of the configuration.
*/
@Nullable VIEW newValue();
/**
- * @return Monotonously increasing counter, linked to the specific storage for current configuration values. Gives
+ * Returns monotonously increasing counter, linked to the specific storage for current configuration values. Gives
* a unique change identifier inside a specific configuration storage.
+ *
+ * @return Counter value.
*/
long storageRevision();
}
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/package-info.java
similarity index 65%
copy from modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
copy to modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/package-info.java
index a58b0c3..9b75153 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/notifications/package-info.java
@@ -15,21 +15,7 @@
* limitations under the License.
*/
-package org.apache.ignite.configuration.validation;
-
-import java.lang.annotation.Documented;
-import java.lang.annotation.Retention;
-import java.lang.annotation.Target;
-
-import static java.lang.annotation.ElementType.FIELD;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
-
/**
- * Signifies that this value has upper limit (exclusive).
+ * Interfaces and classes for configuration notifications.
*/
-@Target(FIELD)
-@Retention(RUNTIME)
-@Documented
-public @interface Max {
- long value();
-}
+package org.apache.ignite.configuration.notifications;
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/package-info.java
similarity index 65%
copy from modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
copy to modules/configuration-api/src/main/java/org/apache/ignite/configuration/package-info.java
index a58b0c3..368a465 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/package-info.java
@@ -15,21 +15,7 @@
* limitations under the License.
*/
-package org.apache.ignite.configuration.validation;
-
-import java.lang.annotation.Documented;
-import java.lang.annotation.Retention;
-import java.lang.annotation.Target;
-
-import static java.lang.annotation.ElementType.FIELD;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
-
/**
- * Signifies that this value has upper limit (exclusive).
+ * Basic classes and interfaces for describing and handling configuration trees.
*/
-@Target(FIELD)
-@Retention(RUNTIME)
-@Documented
-public @interface Max {
- long value();
-}
+package org.apache.ignite.configuration;
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ConfigurationValidationException.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ConfigurationValidationException.java
index dd8185e..097944e 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ConfigurationValidationException.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ConfigurationValidationException.java
@@ -28,18 +28,29 @@ public class ConfigurationValidationException extends RuntimeException {
/**
* Constructor.
+ *
* @param message Exception message.
*/
public ConfigurationValidationException(String message) {
super(message);
}
+ /**
+ * Constructor.
+ *
+ * @param issues List of issues occurred during validation.
+ */
public ConfigurationValidationException(List<ValidationIssue> issues) {
super(issues.toString());
this.issues = issues;
}
+ /**
+ * Returns list of issues occurred during validation.
+ *
+ * @return List of issues occurred during validation.
+ */
public List<ValidationIssue> getIssues() {
return issues;
}
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
index a58b0c3..8a4f19a 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Max.java
@@ -31,5 +31,10 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Retention(RUNTIME)
@Documented
public @interface Max {
+ /**
+ * Returns the upper bound for the value.
+ *
+ * @return upper bound for the value.
+ */
long value();
}
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
index 97e984d..54b1ac4 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
@@ -31,5 +31,10 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Retention(RUNTIME)
@Documented
public @interface Min {
+ /**
+ * Returns the lower bound for the value.
+ *
+ * @return lower bound for the value.
+ */
long value();
}
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationContext.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationContext.java
index 6f9d84f..39c9718 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationContext.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationContext.java
@@ -25,19 +25,34 @@ import org.jetbrains.annotations.Nullable;
/**
* 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 the key of validated node.
+ *
+ * @return String representation of currently validated value, i.e. {@code root.config.node}.
+ */
String currentKey();
- /** @return Previous value of the configuration. Might be null for leaves only. */
+ /**
+ * Returns previous value of the configuration.
+ *
+ * @return Previous value of the configuration. Might be null for leaves only.
+ */
@Nullable VIEW getOldValue();
- /** @return Updated value of the configuration. Cannot be null. */
+ /**
+ * Returns updated value of the configuration.
+ *
+ * @return Updated value of the configuration. Cannot be null.
+ */
@NotNull VIEW getNewValue();
/**
+ * Returns previous value of the configuration root.
+ *
* @param rootKey Root key.
* @return Configuration root view before updates. Guaranteed to return valid value only if root belongs to the same
* storage as currently validated value. Otherwise result of the method may very between invocations or even
@@ -48,6 +63,8 @@ public interface ValidationContext<VIEW> {
@Nullable <ROOT> ROOT getOldRoot(RootKey<?, ROOT> rootKey);
/**
+ * Returns updated value of the configuration root.
+ *
* @param rootKey Root key.
* @return Configuration root view after updates. Guaranteed to return valid value only if root belongs to the same
* storage as currently validated value. Otherwise result of the method may very between invocations or even
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationIssue.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationIssue.java
index 37f2b70..65ea0e7 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationIssue.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/ValidationIssue.java
@@ -18,12 +18,16 @@ package org.apache.ignite.configuration.validation;
import org.apache.ignite.internal.tostring.S;
-/** */
+/**
+ * Class that stores information about issues found during the configuration validation.
+ */
public class ValidationIssue {
- /** */
+ /** Message. */
private final String message;
/**
+ * Constructor.
+ *
* @param message Error message.
*/
public ValidationIssue(String message) {
@@ -31,6 +35,8 @@ public class ValidationIssue {
}
/**
+ * Returns error message.
+ *
* @return Error message.
*/
public String message() {
diff --git a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/package-info.java
similarity index 69%
copy from modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
copy to modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/package-info.java
index 97e984d..d637298 100644
--- a/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/Min.java
+++ b/modules/configuration-api/src/main/java/org/apache/ignite/configuration/validation/package-info.java
@@ -15,21 +15,7 @@
* limitations under the License.
*/
-package org.apache.ignite.configuration.validation;
-
-import java.lang.annotation.Documented;
-import java.lang.annotation.Retention;
-import java.lang.annotation.Target;
-
-import static java.lang.annotation.ElementType.FIELD;
-import static java.lang.annotation.RetentionPolicy.RUNTIME;
-
/**
- * Signifies that this value has lower limit (exclusive).
+ * Interfaces and classes for configuration validation.
*/
-@Target(FIELD)
-@Retention(RUNTIME)
-@Documented
-public @interface Min {
- long value();
-}
+package org.apache.ignite.configuration.validation;