IGNITE-15877 Fix the code style javadocs issues for the modules (step #2). Fixes #438

Signed-off-by: Slava Koptilin <[email protected]>

Author: tkalkirill

modules/affinity/src/main/java/org/apache/ignite/internal/affinity/RendezvousAffinityFunction.java

@@ -183,7 +183,7 @@ public static List<ClusterNode> assignPartition(
     }
 
     /**
-     * Creates assignment for REPLICATED table
+     * Creates assignment for REPLICATED table.
      *
      * @param nodes       Topology.
      * @param sortedNodes Sorted for specified partitions nodes.
@@ -302,7 +302,7 @@ public static Map<String, Collection<ClusterNode>> neighbors(Collection<ClusterN
     }
 
     /**
-     *
+     * Hash comparator.
      */
     private static class HashComparator implements Comparator<IgniteBiTuple<Long, ClusterNode>>, Serializable {
         /** Serial version uid. */
@@ -317,16 +317,18 @@ public int compare(IgniteBiTuple<Long, ClusterNode> o1, IgniteBiTuple<Long, Clus
     }
 
     /**
-     * Sorts the initial array with linear sort algorithm array
+     * Sorts the initial array with linear sort algorithm array.
      */
     private static class LazyLinearSortedContainer implements Iterable<ClusterNode> {
         /** Initial node-hash array. */
         private final IgniteBiTuple<Long, ClusterNode>[] arr;
 
-        /** Count of the sorted elements */
+        /** Count of the sorted elements. */
         private int sorted;
 
         /**
+         * Constructor.
+         *
          * @param arr                Node / partition hash list.
          * @param needFirstSortedCnt Estimate count of elements to return by iterator.
          */
@@ -347,7 +349,7 @@ public Iterator<ClusterNode> iterator() {
         }
 
         /**
-         *
+         * Sorting iterator.
          */
         private class SortIterator implements Iterator<ClusterNode> {
             /** Index of the first unsorted element. */

modules/affinity/src/test/java/org/apache/ignite/internal/affinity/AffinityServiceTest.java

@@ -32,9 +32,6 @@
  * just checks {@link AffinityUtils} logic.
  */
 public class AffinityServiceTest {
-    /**
-     *
-     */
     @Test
     public void testCalculatedAssignmentHappyPath() {
         List<List<ClusterNode>> assignments = AffinityUtils.calculateAssignments(
@@ -59,9 +56,6 @@ public void testCalculatedAssignmentHappyPath() {
         }
     }
 
-    /**
-     *
-     */
     @Test
     public void testEmptyBaselineAssignmentsCalculation() {
         List<List<ClusterNode>> assignments = AffinityUtils.calculateAssignments(

modules/cli/src/integrationTest/java/org/apache/ignite/cli/ItConfigCommandTest.java

@@ -56,10 +56,10 @@ public class ItConfigCommandTest extends AbstractCliTest {
     /** stdout. */
     private ByteArrayOutputStream out;
 
-    /** Port for REST communication */
+    /** Port for REST communication. */
     private int restPort;
 
-    /** Port for thin client communication */
+    /** Port for thin client communication. */
     private int clientPort;
 
     /** Network port. */
@@ -68,9 +68,6 @@ public class ItConfigCommandTest extends AbstractCliTest {
     /** Node. */
     private Ignite node;
 
-    /**
-     *
-     */
     @BeforeEach
     void setup(@TempDir Path workDir, TestInfo testInfo) throws IOException {
         // TODO: IGNITE-15131 Must be replaced by receiving the actual port configs from the started node.
@@ -95,9 +92,6 @@ void setup(@TempDir Path workDir, TestInfo testInfo) throws IOException {
         out = new ByteArrayOutputStream();
     }
 
-    /**
-     *
-     */
     @AfterEach
     void tearDown(TestInfo testInfo) {
         IgnitionManager.stop(testNodeName(testInfo, networkPort));
@@ -163,6 +157,8 @@ public void partialGet() {
     }
 
     /**
+     * Returns any available prt.
+     *
      * @return Any available port.
      * @throws IOException if can't allocate port to open socket.
      */
@@ -174,6 +170,8 @@ private int getAvailablePort() throws IOException {
     }
 
     /**
+     * Creates a new command line interpreter.
+     *
      * @param applicationCtx DI context.
      * @return New command line instance.
      */

modules/cli/src/main/java/org/apache/ignite/cli/CliPathsConfigLoader.java

@@ -28,7 +28,7 @@
 import org.apache.ignite.cli.builtins.SystemPathResolver;
 
 /**
- * Due to the nature of Ignite CLI tool it can be runned in the environment without ignitecfg file at all. This class created to simplify
+ * Due to the nature of Ignite CLI tool it can be run in the environment without configuration file at all. This class created to simplify
  * the managing of the different cases:
  * <ul>
  *     <li>When user download binary and run it to manage any existence remote cluster</li>
@@ -93,6 +93,8 @@ public IgnitePaths loadIgnitePathsOrThrowError() {
     }
 
     /**
+     * Returns path to Ignite CLI configuration file.
+     *
      * @return Path to Ignite CLI config file.
      */
     public Path configFilePath() {

modules/cli/src/main/java/org/apache/ignite/cli/IgniteCliApp.java

@@ -30,6 +30,11 @@
  * Entry point of Ignite CLI.
  */
 public class IgniteCliApp {
+    /**
+     * Entry point of Ignite CLI.
+     *
+     * @param args Command line arguments.
+     */
     public static void main(String... args) {
         initJavaLoggerProps();
 

modules/cli/src/main/java/org/apache/ignite/cli/IgniteCliException.java

@@ -25,14 +25,18 @@ public class IgniteCliException extends RuntimeException {
     private static final long serialVersionUID = 0L;
 
     /**
-     * @param msg Message.
+     * Creates a new instance of {@code IgniteCliException} with the given {@code msg}.
+     *
+     * @param msg Detailed message.
      */
     public IgniteCliException(String msg) {
         super(msg);
     }
 
     /**
-     * @param msg   Message.
+     * Creates a new instance of {@code IgniteCliException} with the given {@code msg} and {@code cause}.
+     *
+     * @param msg   Detailed message.
      * @param cause Cause.
      */
     public IgniteCliException(String msg, Throwable cause) {

modules/cli/src/main/java/org/apache/ignite/cli/IgnitePaths.java

@@ -63,7 +63,7 @@ public class IgnitePaths {
     /** Directory for storing server node configs. */
     public final Path cfgDir;
 
-    /** Directory for server nodes logs */
+    /** Directory for server nodes logs. */
     public final Path logDir;
 
     /**
@@ -89,48 +89,62 @@ public IgnitePaths(Path binDir, Path workDir, Path cfgDir, Path logDir, String v
     }
 
     /**
+     * Returns a path where CLI module artifacts will be placed.
+     *
      * @return Path where CLI module artifacts will be placed.
      */
     public Path cliLibsDir() {
         return binDir.resolve(ver).resolve("cli");
     }
 
     /**
+     * Returns a path where Ignite server module artifacts will be placed..
+     *
      * @return Path where Ignite server module artifacts will be placed.
      */
     public Path libsDir() {
         return binDir.resolve(ver).resolve("libs");
     }
 
     /**
+     * Returns a path where Ignite node pid files will be created.
+     *
      * @return Path where Ignite node pid files will be created.
      */
     public Path cliPidsDir() {
         return workDir.resolve("cli").resolve("pids");
     }
 
     /**
-     * @return Path to file with registry data for {@link org.apache.ignite.cli.builtins.module.ModuleRegistry}
+     * Returns a path to file with registry data for {@link org.apache.ignite.cli.builtins.module.ModuleRegistry}.
+     *
+     * @return Path to file with registry data for {@link org.apache.ignite.cli.builtins.module.ModuleRegistry}.
      */
     public Path installedModulesFile() {
         return workDir.resolve("modules.json");
     }
 
     /**
+     * Returns a path to directory with Ignite nodes configs.
+     *
      * @return Path to directory with Ignite nodes configs.
      */
     public Path serverConfigDir() {
         return workDir.resolve("config");
     }
 
     /**
+     * Returns a path to default Ignite node config.
+     *
      * @return Path to default Ignite node config.
      */
     public Path serverDefaultConfigFile() {
         return cfgDir.resolve("default-config.xml");
     }
 
     /**
+     * Returns a path to default Ignite node config.
+     *
      * @return Path to default Ignite node config.
      */
     public Path serverJavaUtilLoggingPros() {

modules/cli/src/main/java/org/apache/ignite/cli/InteractiveWrapper.java

@@ -44,14 +44,16 @@ public class InteractiveWrapper {
     private final Terminal terminal;
 
     /**
+     * Creates a new instance of {@code InteractiveWrapper} for the given {@code terminal}.
+     *
      * @param terminal Terminal.
      */
     public InteractiveWrapper(Terminal terminal) {
         this.terminal = terminal;
     }
 
     /**
-     * Start interactive shell.
+     * Starts interactive shell.
      *
      * @param cmd Prepared CommandLine instance to use for interactive mode.
      */
@@ -103,7 +105,10 @@ public Object invoke(CommandSession ses, String cmd, Object... args) throws Exce
     }
 
     /**
+     * Returns a path to the user directory.
+     * This is the directory where JVM was run from.
      *
+     * @return Path to the user directory.
      */
     private static Path workDir() {
         return Paths.get(System.getProperty("user.dir"));

modules/cli/src/main/java/org/apache/ignite/cli/Table.java

@@ -33,7 +33,7 @@ public class Table {
     /** Color scheme for table output. */
     private final ColorScheme cs;
 
-    /** Table data */
+    /** Table data. */
     private final Collection<Row> data = new ArrayList<>();
 
     /** Columns lengths. */
@@ -116,9 +116,6 @@ public String toString() {
         return sb.toString().stripTrailing();
     }
 
-    /**
-     *
-     */
     private void appendLine(StringBuilder sb) {
         sb.append(" ".repeat(indent));
 
@@ -130,7 +127,10 @@ private void appendLine(StringBuilder sb) {
     }
 
     /**
+     * Appends the given {@code row} to the specified string builder {@code sb}.
      *
+     * @param sb String builder that accumulates a result.
+     * @param row Row to be appended to the string builder.
      */
     private void appendRow(StringBuilder sb, Row row) {
         sb.append(" ".repeat(indent))
@@ -148,13 +148,13 @@ private interface Row {
      * Row with actual data.
      */
     private class DataRow implements Row {
-        /**
-         *
-         */
+        /** Text. */
         private final Text[] row;
 
         /**
+         * Creates a new {@code DataRow} with the specified data.
          *
+         * @param row Text to be rendered.
          */
         DataRow(Text[] row) {
             this.row = row;
@@ -185,13 +185,11 @@ public String render() {
      * Row with table title.
      */
     private class SectionTitle implements Row {
-        /**
-         *
-         */
+        /** Title. */
         private final Text title;
 
         /**
-         *
+         * Creates a new {@code SectionTitle} with the given {@code title}.
          */
         SectionTitle(Text title) {
             this.title = title;

modules/cli/src/main/java/org/apache/ignite/cli/builtins/SystemPathResolver.java

@@ -30,17 +30,21 @@
  */
 public interface SystemPathResolver {
     /**
+     * Returns system specific user home directory..
+     *
      * @return System specific user home directory.
      */
     Path osHomeDirectoryPath();
 
     /**
+     * Returns directory where CLI tool binary placed.
+     *
      * @return Directory where CLI tool binary placed.
      */
     Path toolHomeDirectoryPath();
 
     /**
-     *
+     * Default path resolver.
      */
     @Singleton
     @Introspected