You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by vv...@apache.org on 2021/11/08 14:43:37 UTC
[ignite-3] branch main updated: IGNITE-15876 Fix the code style
javadocs issues for the modules / Part 1 (#430)
This is an automated email from the ASF dual-hosted git repository.
vveider 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 d0de3a4 IGNITE-15876 Fix the code style javadocs issues for the modules / Part 1 (#430)
d0de3a4 is described below
commit d0de3a4587cdfc96db7a2cc715ec34a606c08028
Author: Kirill Tkalenko <tk...@yandex.ru>
AuthorDate: Mon Nov 8 17:43:34 2021 +0300
IGNITE-15876 Fix the code style javadocs issues for the modules / Part 1 (#430)
---
.../ignite/example/rebalance/RebalanceExample.java | 6 +
.../ignite/example/sql/jdbc/SqlJdbcExample.java | 6 +
.../ignite/example/table/KeyValueViewExample.java | 6 +
.../ignite/example/table/RecordViewExample.java | 6 +
.../ignite/example/sql/jdbc/SqlExamplesTest.java | 12 +-
.../ignite/example/table/TableExamplesTest.java | 12 +-
.../network/InboundConfigurationSchema.java | 2 +-
.../network/OutboundConfigurationSchema.java | 2 +-
.../ignite/internal/client/ClientChannel.java | 2 +
.../client/ClientChannelConfiguration.java | 4 +
.../ignite/internal/client/HostAndPortRange.java | 6 +
.../internal/client/ProtocolBitmaskFeature.java | 15 +-
.../ignite/internal/client/ProtocolContext.java | 6 +
.../ignite/internal/client/ReliableChannel.java | 14 +-
.../ignite/internal/client/TcpClientChannel.java | 6 +-
.../client/io/netty/NettyClientConnection.java | 2 +-
.../io/netty/NettyClientConnectionMultiplexer.java | 8 +-
.../client/query/JdbcClientQueryEventHandler.java | 2 +
.../ignite/internal/client/table/ClientSchema.java | 6 +
.../ignite/internal/client/table/ClientTable.java | 75 +++++--
.../ignite/internal/client/table/ClientTables.java | 3 -
.../apache/ignite/client/AbstractClientTest.java | 29 +++
.../java/org/apache/ignite/client/CustomTuple.java | 125 +++++++-----
.../org/apache/ignite/client/fakes/FakeCursor.java | 4 +-
.../org/apache/ignite/client/fakes/FakeIgnite.java | 5 +-
.../client/fakes/FakeIgniteQueryProcessor.java | 3 +
.../ignite/client/fakes/FakeIgniteTables.java | 9 -
.../ignite/client/fakes/FakeSchemaRegistry.java | 2 +-
.../configuration/tree/TraversableTreeNode.java | 8 +-
.../util/ConfigurationNotificationsUtil.java | 2 +-
.../configuration/util/ConfigurationUtil.java | 8 +-
.../configuration/util/KeyNotFoundException.java | 4 +-
.../util/KeysTrackingConfigurationVisitor.java | 4 +
.../validation/ImmutableValidator.java | 3 +
.../validation/ValidationContextImpl.java | 12 +-
.../configuration/validation/ValidationUtil.java | 7 +-
.../configuration/ConfigurationChangerTest.java | 53 +----
.../configuration/ConfigurationRegistryTest.java | 12 +-
.../configuration/DirectPropertiesTest.java | 49 +----
.../asm/ConfigurationAsmGeneratorTest.java | 39 ----
.../configuration/hocon/HoconConverterTest.java | 86 +-------
.../ConfigurationAnyListenerTest.java | 40 +---
.../notifications/ConfigurationListenerTest.java | 47 +----
.../ConfigurationListenerTestUtils.java | 12 ++
.../sample/BaselineConfigurationSchema.java | 2 +-
.../internal/configuration/sample/UsageTest.java | 6 -
.../testframework/BasicConfigurationSchema.java | 3 -
.../testframework/ExtendedConfigurationSchema.java | 3 -
.../configuration/tree/ConfigurationArrayTest.java | 60 ++----
.../tree/ConstructableTreeNodeTest.java | 43 ++--
.../configuration/tree/NamedListNodeTest.java | 10 +-
.../tree/TraversableTreeNodeTest.java | 39 ++--
.../configuration/util/ConfigurationUtilTest.java | 76 ++-----
.../validation/OneOfValidatorTest.java | 4 +-
.../validation/ValidationUtilTest.java | 68 +++----
.../ItTransferableObjectProcessorTest.java | 5 +-
.../internal/network/processor/MessageClass.java | 47 +++--
.../network/processor/MessageGroupWrapper.java | 24 ++-
.../network/processor/ProcessingException.java | 14 +-
.../processor/TransferableObjectProcessor.java | 6 +-
.../internal/network/processor/TypeUtils.java | 12 +-
.../messages/MessageBuilderGenerator.java | 10 +-
.../messages/MessageFactoryGenerator.java | 10 +-
.../processor/messages/MessageImplGenerator.java | 10 +-
.../serialization/BaseMethodNameResolver.java | 8 +-
.../MessageCollectionItemTypeConverter.java | 8 +-
.../MessageDeserializerGenerator.java | 10 +-
.../serialization/MessageReaderMethodResolver.java | 12 +-
.../serialization/MessageSerializerGenerator.java | 10 +-
.../serialization/MessageWriterMethodResolver.java | 12 +-
.../RegistryInitializerGenerator.java | 10 +-
.../SerializationFactoryGenerator.java | 10 +-
.../apache/ignite/network/MessagingService.java | 4 +-
.../network/netty/ItConnectionManagerTest.java | 2 +-
.../network/recovery/ItRecoveryHandshakeTest.java | 6 +-
.../network/direct/DirectMessageReader.java | 6 +-
.../network/direct/DirectMessageWriter.java | 17 +-
.../network/direct/state/DirectMessageState.java | 4 +
.../direct/stream/DirectByteBufferStream.java | 220 +++++++++++++++------
.../stream/DirectByteBufferStreamImplV1.java | 174 ++++++----------
.../network/handshake/HandshakeManager.java | 2 +
.../internal/network/netty/ConnectionManager.java | 10 +
.../ignite/internal/network/netty/NettyClient.java | 6 +
.../ignite/internal/network/netty/NettySender.java | 8 +
.../ignite/internal/network/netty/NettyServer.java | 10 +-
.../recovery/RecoveryClientHandshakeManager.java | 8 +-
.../recovery/RecoveryServerHandshakeManager.java | 8 +-
.../recovery/message/HandshakeStartMessage.java | 8 +-
.../message/HandshakeStartResponseMessage.java | 16 +-
.../ignite/internal/network/AllTypesMessage.java | 3 +
.../internal/network/NestedMessageMessage.java | 3 +
.../netty/IoExceptionSuppressingHandlerTest.java | 8 +-
.../internal/network/netty/NettyClientTest.java | 15 +-
.../internal/network/netty/NettyServerTest.java | 6 +-
.../internal/network/processor/EmptyMessage.java | 2 +-
.../network/processor/EmptyMessageTest.java | 5 +-
.../network/processor/InheritedMessage.java | 6 +-
.../network/processor/InheritedMessageTest.java | 8 +-
.../network/processor/NetworkMessage1.java | 5 +-
.../network/processor/NetworkMessage2.java | 6 +-
.../processor/SerializationOrderMessage.java | 18 +-
.../network/processor/SerializationOrderTest.java | 8 +-
.../MessageSerializationRegistryImplTest.java | 16 +-
.../org/apache/ignite/network/TestMessage.java | 3 +
.../apache/ignite/network/TestMessageTypes.java | 24 +--
.../ignite/internal/rocksdb/ColumnFamily.java | 4 +
.../apache/ignite/internal/storage/DataRow.java | 4 +
.../ignite/internal/storage/InvokeClosure.java | 7 +
.../apache/ignite/internal/storage/SearchRow.java | 4 +
.../ignite/internal/storage/StorageException.java | 6 +
.../storage/basic/GetAndRemoveInvokeClosure.java | 2 +
.../storage/basic/GetAndReplaceInvokeClosure.java | 2 +
.../internal/storage/basic/SimpleDataRow.java | 2 +
.../storage/basic/SimpleWriteInvokeClosure.java | 2 +
.../storage/rocksdb/RocksDbDataRegion.java | 2 +
.../storage/rocksdb/RocksDbPartitionStorage.java | 4 +-
.../storage/rocksdb/RocksDbTableStorage.java | 5 +-
.../storage/rocksdb/RocksDbStorageTest.java | 12 +-
118 files changed, 941 insertions(+), 1056 deletions(-)
diff --git a/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java b/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java
index 5bdf982..9725acf 100644
--- a/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java
+++ b/examples/src/main/java/org/apache/ignite/example/rebalance/RebalanceExample.java
@@ -55,6 +55,12 @@ import org.apache.ignite.table.Tuple;
* </ol>
*/
public class RebalanceExample {
+ /**
+ * Main method of the example.
+ *
+ * @param args The command line arguments.
+ * @throws Exception If failed.
+ */
public static void main(String[] args) throws Exception {
//--------------------------------------------------------------------------------------
//
diff --git a/examples/src/main/java/org/apache/ignite/example/sql/jdbc/SqlJdbcExample.java b/examples/src/main/java/org/apache/ignite/example/sql/jdbc/SqlJdbcExample.java
index 73f228d..78667b9 100644
--- a/examples/src/main/java/org/apache/ignite/example/sql/jdbc/SqlJdbcExample.java
+++ b/examples/src/main/java/org/apache/ignite/example/sql/jdbc/SqlJdbcExample.java
@@ -45,6 +45,12 @@ import org.apache.ignite.schema.definition.TableDefinition;
* </ol>
*/
public class SqlJdbcExample {
+ /**
+ * Main method of the example.
+ *
+ * @param args The command line arguments.
+ * @throws Exception If failed.
+ */
public static void main(String[] args) throws Exception {
//--------------------------------------------------------------------------------------
//
diff --git a/examples/src/main/java/org/apache/ignite/example/table/KeyValueViewExample.java b/examples/src/main/java/org/apache/ignite/example/table/KeyValueViewExample.java
index 4902451..550d00f 100644
--- a/examples/src/main/java/org/apache/ignite/example/table/KeyValueViewExample.java
+++ b/examples/src/main/java/org/apache/ignite/example/table/KeyValueViewExample.java
@@ -43,6 +43,12 @@ import org.apache.ignite.table.Tuple;
* </ol>
*/
public class KeyValueViewExample {
+ /**
+ * Main method of the example.
+ *
+ * @param args The command line arguments.
+ * @throws Exception If failed.
+ */
public static void main(String[] args) throws Exception {
//--------------------------------------------------------------------------------------
//
diff --git a/examples/src/main/java/org/apache/ignite/example/table/RecordViewExample.java b/examples/src/main/java/org/apache/ignite/example/table/RecordViewExample.java
index 4d6584a..b975984 100644
--- a/examples/src/main/java/org/apache/ignite/example/table/RecordViewExample.java
+++ b/examples/src/main/java/org/apache/ignite/example/table/RecordViewExample.java
@@ -43,6 +43,12 @@ import org.apache.ignite.table.Tuple;
* </ol>
*/
public class RecordViewExample {
+ /**
+ * Main method of the example.
+ *
+ * @param args The command line arguments.
+ * @throws Exception If failed.
+ */
public static void main(String[] args) throws Exception {
//--------------------------------------------------------------------------------------
//
diff --git a/examples/src/test/java/org/apache/ignite/example/sql/jdbc/SqlExamplesTest.java b/examples/src/test/java/org/apache/ignite/example/sql/jdbc/SqlExamplesTest.java
index e958b37..64107ff 100644
--- a/examples/src/test/java/org/apache/ignite/example/sql/jdbc/SqlExamplesTest.java
+++ b/examples/src/test/java/org/apache/ignite/example/sql/jdbc/SqlExamplesTest.java
@@ -62,7 +62,12 @@ public class SqlExamplesTest {
+ " Richard, Miles, St. Petersburg\n"
);
}
-
+
+ /**
+ * Start node.
+ *
+ * @param workDir Work directory for the started node. Must not be {@code null}.
+ */
@BeforeEach
public void startNode(@WorkDirectory Path workDir) throws IOException {
IgnitionManager.start(
@@ -71,7 +76,10 @@ public class SqlExamplesTest {
workDir
);
}
-
+
+ /**
+ * Stop node.
+ */
@AfterEach
public void stopNode() {
IgnitionManager.stop("my-first-node");
diff --git a/examples/src/test/java/org/apache/ignite/example/table/TableExamplesTest.java b/examples/src/test/java/org/apache/ignite/example/table/TableExamplesTest.java
index 7d15538..475b438 100644
--- a/examples/src/test/java/org/apache/ignite/example/table/TableExamplesTest.java
+++ b/examples/src/test/java/org/apache/ignite/example/table/TableExamplesTest.java
@@ -65,7 +65,12 @@ public class TableExamplesTest {
+ " Owner: Val Kulichenko\n"
+ " Balance: $100.0\n");
}
-
+
+ /**
+ * Start node.
+ *
+ * @param workDir Work directory for the started node. Must not be {@code null}.
+ */
@BeforeEach
public void startNode(@WorkDirectory Path workDir) throws IOException {
IgnitionManager.start(
@@ -74,7 +79,10 @@ public class TableExamplesTest {
workDir
);
}
-
+
+ /**
+ * Stop node.
+ */
@AfterEach
public void stopNode() {
IgnitionManager.stop("my-first-node");
diff --git a/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/InboundConfigurationSchema.java b/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/InboundConfigurationSchema.java
index 478f0fe..752313a 100644
--- a/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/InboundConfigurationSchema.java
+++ b/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/InboundConfigurationSchema.java
@@ -28,7 +28,7 @@ import org.apache.ignite.configuration.validation.Min;
*/
@Config
public class InboundConfigurationSchema {
- /** Backlog value */
+ /** Backlog value. */
@Min(0)
@Value(hasDefault = true)
public final int soBacklog = 128;
diff --git a/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/OutboundConfigurationSchema.java b/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/OutboundConfigurationSchema.java
index b3da692..ece724b 100644
--- a/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/OutboundConfigurationSchema.java
+++ b/modules/api/src/main/java/org/apache/ignite/configuration/schemas/network/OutboundConfigurationSchema.java
@@ -37,7 +37,7 @@ public class OutboundConfigurationSchema {
@Value(hasDefault = true)
public final int soLinger = 0;
- /** TCP no delay flag */
+ /** TCP no delay flag. */
@Value(hasDefault = true)
public final boolean tcpNoDelay = true;
}
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannel.java b/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannel.java
index 0e54a59..6c06b5c 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannel.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannel.java
@@ -45,6 +45,8 @@ interface ClientChannel extends AutoCloseable {
);
/**
+ * Returns {@code true} channel is closed.
+ *
* @return {@code True} channel is closed.
*/
public boolean closed();
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannelConfiguration.java b/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannelConfiguration.java
index 1e4922e..255d788 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannelConfiguration.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/ClientChannelConfiguration.java
@@ -42,6 +42,8 @@ final class ClientChannelConfiguration {
}
/**
+ * Returns address.
+ *
* @return Address.
*/
public InetSocketAddress getAddress() {
@@ -49,6 +51,8 @@ final class ClientChannelConfiguration {
}
/**
+ * Returns config.
+ *
* @return Config.
*/
public IgniteClientConfiguration clientConfiguration() {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/HostAndPortRange.java b/modules/client/src/main/java/org/apache/ignite/internal/client/HostAndPortRange.java
index aa67fa6..e740e2c 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/HostAndPortRange.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/HostAndPortRange.java
@@ -229,6 +229,8 @@ public class HostAndPortRange implements Serializable {
}
/**
+ * Returns host.
+ *
* @return Host.
*/
public String host() {
@@ -236,6 +238,8 @@ public class HostAndPortRange implements Serializable {
}
/**
+ * Returns port from.
+ *
* @return Port from.
*/
public int portFrom() {
@@ -243,6 +247,8 @@ public class HostAndPortRange implements Serializable {
}
/**
+ * Returns port to.
+ *
* @return Port to.
*/
public int portTo() {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolBitmaskFeature.java b/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolBitmaskFeature.java
index aecc2c4..2c0daa3 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolBitmaskFeature.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolBitmaskFeature.java
@@ -27,10 +27,7 @@ import java.util.EnumSet;
public enum ProtocolBitmaskFeature {
/** Feature for user attributes. */
USER_ATTRIBUTES(0);
-
- /**
- *
- */
+
private static final EnumSet<ProtocolBitmaskFeature> ALL_FEATURES_AS_ENUM_SET =
EnumSet.allOf(ProtocolBitmaskFeature.class);
@@ -38,6 +35,8 @@ public enum ProtocolBitmaskFeature {
private final int featureId;
/**
+ * Constructor.
+ *
* @param id Feature ID.
*/
ProtocolBitmaskFeature(int id) {
@@ -45,6 +44,8 @@ public enum ProtocolBitmaskFeature {
}
/**
+ * Returns feature ID.
+ *
* @return Feature ID.
*/
public int featureId() {
@@ -52,6 +53,8 @@ public enum ProtocolBitmaskFeature {
}
/**
+ * Returns set of supported features.
+ *
* @param bytes Feature byte array.
* @return Set of supported features.
*/
@@ -74,6 +77,8 @@ public enum ProtocolBitmaskFeature {
}
/**
+ * Returns byte array representing all supported features.
+ *
* @param features Feature set.
* @return Byte array representing all supported features.
*/
@@ -88,6 +93,8 @@ public enum ProtocolBitmaskFeature {
}
/**
+ * Returns all features as a set.
+ *
* @return All features as a set.
*/
public static EnumSet<ProtocolBitmaskFeature> allFeaturesAsEnumSet() {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolContext.java b/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolContext.java
index c1b6a3b..59cde78 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolContext.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/ProtocolContext.java
@@ -32,6 +32,8 @@ public class ProtocolContext {
private final EnumSet<ProtocolBitmaskFeature> features;
/**
+ * Constructor.
+ *
* @param ver Protocol version.
* @param features Supported features.
*/
@@ -63,6 +65,8 @@ public class ProtocolContext {
}
/**
+ * Returns supported features.
+ *
* @return Supported features.
*/
public EnumSet<ProtocolBitmaskFeature> features() {
@@ -70,6 +74,8 @@ public class ProtocolContext {
}
/**
+ * Returns protocol version.
+ *
* @return Protocol version.
*/
public ProtocolVersion version() {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/ReliableChannel.java b/modules/client/src/main/java/org/apache/ignite/internal/client/ReliableChannel.java
index 6b6c742..7942325 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/ReliableChannel.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/ReliableChannel.java
@@ -250,6 +250,9 @@ public final class ReliableChannel implements AutoCloseable {
}
/**
+ * Returns host:port_range address lines parsed as {@link InetSocketAddress} as a key. Value is the amount of appearences of an address
+ * in {@code addrs} parameter.
+ *
* @return host:port_range address lines parsed as {@link InetSocketAddress} as a key. Value is the amount of appearences of an address
* in {@code addrs} parameter.
*/
@@ -332,6 +335,8 @@ public final class ReliableChannel implements AutoCloseable {
}
/**
+ * Adds listener for the channel fail (disconnect).
+ *
* @param chFailLsnr Listener for the channel fail (disconnect).
*/
public void addChannelFailListener(Runnable chFailLsnr) {
@@ -470,10 +475,7 @@ public final class ReliableChannel implements AutoCloseable {
// TODO: Async startup IGNITE-15357.
return CompletableFuture.completedFuture(null);
}
-
- /**
- *
- */
+
private <T> T applyOnDefaultChannel(Function<ClientChannel, T> function) {
return applyOnDefaultChannel(function, getRetryLimit(), DO_NOTHING);
}
@@ -558,6 +560,8 @@ public final class ReliableChannel implements AutoCloseable {
private final long[] reconnectRetries;
/**
+ * Constructor.
+ *
* @param chCfg Channel config.
*/
private ClientChannelHolder(ClientChannelConfiguration chCfg) {
@@ -570,6 +574,8 @@ public final class ReliableChannel implements AutoCloseable {
}
/**
+ * Returns whether reconnect throttling should be applied.
+ *
* @return Whether reconnect throttling should be applied.
*/
private boolean applyReconnectionThrottling() {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/TcpClientChannel.java b/modules/client/src/main/java/org/apache/ignite/internal/client/TcpClientChannel.java
index 83299e1..c4cd16a 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/TcpClientChannel.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/TcpClientChannel.java
@@ -150,6 +150,8 @@ class TcpClientChannel implements ClientChannel, ClientMessageHandler, ClientCon
}
/**
+ * Constructor.
+ *
* @param opCode Operation code.
* @param payloadWriter Payload writer to stream or {@code null} if request has no payload.
* @return Request future.
@@ -330,6 +332,8 @@ class TcpClientChannel implements ClientChannel, ClientMessageHandler, ClientCon
}
/**
+ * Returns protocol context for a version.
+ *
* @param ver Protocol version.
* @return Protocol context for a version.
*/
@@ -385,7 +389,7 @@ class TcpClientChannel implements ClientChannel, ClientMessageHandler, ClientCon
}
/**
- *
+ * Client request future.
*/
private static class ClientRequestFuture extends CompletableFuture<ClientMessageUnpacker> {
}
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnection.java b/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnection.java
index 476d4fe..a0541cb 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnection.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnection.java
@@ -31,7 +31,7 @@ import org.apache.ignite.lang.IgniteException;
* Netty client connection.
*/
public class NettyClientConnection implements ClientConnection {
- /** Connection attribute */
+ /** Connection attribute. */
public static final AttributeKey<NettyClientConnection> ATTR_CONN = AttributeKey.newInstance("CONN");
/** Channel. */
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnectionMultiplexer.java b/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnectionMultiplexer.java
index 4364dc9..35f78ad 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnectionMultiplexer.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/io/netty/NettyClientConnectionMultiplexer.java
@@ -37,14 +37,8 @@ import org.apache.ignite.internal.client.proto.ClientMessageDecoder;
* Netty-based multiplexer.
*/
public class NettyClientConnectionMultiplexer implements ClientConnectionMultiplexer {
- /**
- *
- */
private final NioEventLoopGroup workerGroup;
-
- /**
- *
- */
+
private final Bootstrap bootstrap;
/**
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/query/JdbcClientQueryEventHandler.java b/modules/client/src/main/java/org/apache/ignite/internal/client/query/JdbcClientQueryEventHandler.java
index a7f7236..74099d2 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/query/JdbcClientQueryEventHandler.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/query/JdbcClientQueryEventHandler.java
@@ -46,6 +46,8 @@ public class JdbcClientQueryEventHandler implements JdbcQueryEventHandler {
private final TcpIgniteClient client;
/**
+ * Constructor.
+ *
* @param client TcpIgniteClient.
*/
public JdbcClientQueryEventHandler(TcpIgniteClient client) {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientSchema.java b/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientSchema.java
index 86d36f2..6da2045 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientSchema.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientSchema.java
@@ -66,6 +66,8 @@ public class ClientSchema {
}
/**
+ * Returns version.
+ *
* @return Version.
*/
public int version() {
@@ -73,6 +75,8 @@ public class ClientSchema {
}
/**
+ * Returns columns.
+ *
* @return Columns.
*/
public @NotNull ClientColumn[] columns() {
@@ -107,6 +111,8 @@ public class ClientSchema {
}
/**
+ * Returns key column count.
+ *
* @return Key column count.
*/
public int keyColumnCount() {
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTable.java b/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTable.java
index 1c13bab..eb12b98 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTable.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTable.java
@@ -48,34 +48,16 @@ import org.msgpack.core.MessageFormat;
* Client table API implementation.
*/
public class ClientTable implements Table {
- /**
- *
- */
private final IgniteUuid id;
- /**
- *
- */
private final String name;
- /**
- *
- */
private final ReliableChannel ch;
- /**
- *
- */
private final ConcurrentHashMap<Integer, ClientSchema> schemas = new ConcurrentHashMap<>();
- /**
- *
- */
private volatile int latestSchemaVer = -1;
-
- /**
- *
- */
+
private final Object latestSchemaLock = new Object();
/**
@@ -220,6 +202,13 @@ public class ClientTable implements Table {
return IgniteToStringBuilder.toString(ClientTable.class, this);
}
+ /**
+ * Writes {@link Tuple}.
+ *
+ * @param tuple Tuple.
+ * @param schema Schema.
+ * @param out Out.
+ */
public void writeTuple(
@NotNull Tuple tuple,
ClientSchema schema,
@@ -228,6 +217,14 @@ public class ClientTable implements Table {
writeTuple(tuple, schema, out, false, false);
}
+ /**
+ * Writes {@link Tuple}.
+ *
+ * @param tuple Tuple.
+ * @param schema Schema.
+ * @param out Out.
+ * @param keyOnly Key only.
+ */
public void writeTuple(
@NotNull Tuple tuple,
ClientSchema schema,
@@ -237,6 +234,15 @@ public class ClientTable implements Table {
writeTuple(tuple, schema, out, keyOnly, false);
}
+ /**
+ * Writes {@link Tuple}.
+ *
+ * @param tuple Tuple.
+ * @param schema Schema.
+ * @param out Out.
+ * @param keyOnly Key only.
+ * @param skipHeader Skip header.
+ */
public void writeTuple(
@NotNull Tuple tuple,
ClientSchema schema,
@@ -269,6 +275,15 @@ public class ClientTable implements Table {
}
}
+ /**
+ * Writes key and value {@link Tuple}.
+ *
+ * @param key Key tuple.
+ * @param val Value tuple.
+ * @param schema Schema.
+ * @param out Out.
+ * @param skipHeader Skip header.
+ */
public void writeKvTuple(
@NotNull Tuple key,
@Nullable Tuple val,
@@ -312,6 +327,13 @@ public class ClientTable implements Table {
}
}
+ /**
+ * Writes pairs {@link Tuple}.
+ *
+ * @param pairs Key tuple.
+ * @param schema Schema.
+ * @param out Out.
+ */
public void writeKvTuples(Map<Tuple, Tuple> pairs, ClientSchema schema, ClientMessagePacker out) {
out.packIgniteUuid(id);
out.packInt(schema.version());
@@ -322,6 +344,14 @@ public class ClientTable implements Table {
}
}
+ /**
+ * Writes {@link Tuple}'s.
+ *
+ * @param tuples Tuples.
+ * @param schema Schema.
+ * @param out Out.
+ * @param keyOnly Key only.
+ */
public void writeTuples(
@NotNull Collection<Tuple> tuples,
ClientSchema schema,
@@ -402,6 +432,13 @@ public class ClientTable implements Table {
return new IgniteBiTuple<>(keyTuple, valTuple);
}
+ /**
+ * Reads {@link Tuple} pairs.
+ *
+ * @param schema Schema.
+ * @param in In.
+ * @return Tuple pairs.
+ */
public Map<Tuple, Tuple> readKvTuples(ClientSchema schema, ClientMessageUnpacker in) {
var cnt = in.unpackInt();
Map<Tuple, Tuple> res = new HashMap<>(cnt);
diff --git a/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTables.java b/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTables.java
index c527d5a..1de7f6b 100644
--- a/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTables.java
+++ b/modules/client/src/main/java/org/apache/ignite/internal/client/table/ClientTables.java
@@ -32,9 +32,6 @@ import org.apache.ignite.table.manager.IgniteTables;
* Client tables API implementation.
*/
public class ClientTables implements IgniteTables {
- /**
- *
- */
private final ReliableChannel ch;
/**
diff --git a/modules/client/src/test/java/org/apache/ignite/client/AbstractClientTest.java b/modules/client/src/test/java/org/apache/ignite/client/AbstractClientTest.java
index 1a90011..fbb41ed 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/AbstractClientTest.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/AbstractClientTest.java
@@ -54,6 +54,9 @@ public abstract class AbstractClientTest {
protected static int serverPort;
+ /**
+ * Before all.
+ */
@BeforeAll
public static void beforeAll() {
ResourceLeakDetector.setLevel(ResourceLeakDetector.Level.PARANOID);
@@ -70,6 +73,9 @@ public abstract class AbstractClientTest {
client = startClient();
}
+ /**
+ * After all.
+ */
@AfterAll
public static void afterAll() throws Exception {
client.close();
@@ -77,6 +83,9 @@ public abstract class AbstractClientTest {
configurationRegistry.stop();
}
+ /**
+ * After each.
+ */
@BeforeEach
public void beforeEach() {
for (var t : server.tables().tables()) {
@@ -84,6 +93,12 @@ public abstract class AbstractClientTest {
}
}
+ /**
+ * Returns client.
+ *
+ * @param addrs Addresses.
+ * @return Client.
+ */
public static Ignite startClient(String... addrs) {
if (addrs == null || addrs.length == 0) {
addrs = new String[]{"127.0.0.1:" + serverPort};
@@ -94,6 +109,14 @@ public abstract class AbstractClientTest {
return builder.build();
}
+ /**
+ * Returns server.
+ *
+ * @param port Port.
+ * @param portRange Port range.
+ * @param ignite Ignite.
+ * @return Server.
+ */
public static IgniteBiTuple<ClientHandlerModule, ConfigurationRegistry> startServer(
int port,
int portRange,
@@ -119,6 +142,12 @@ public abstract class AbstractClientTest {
return new IgniteBiTuple<>(module, cfg);
}
+ /**
+ * Assertion of {@link Tuple} equality.
+ *
+ * @param x Tuple.
+ * @param y Tuple.
+ */
public static void assertTupleEquals(Tuple x, Tuple y) {
if (x == null) {
assertNull(y);
diff --git a/modules/client/src/test/java/org/apache/ignite/client/CustomTuple.java b/modules/client/src/test/java/org/apache/ignite/client/CustomTuple.java
index ff84d71..b72f85d 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/CustomTuple.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/CustomTuple.java
@@ -32,36 +32,37 @@ import org.jetbrains.annotations.NotNull;
* User-defined test {@link Tuple} implementation.
*/
public class CustomTuple implements Tuple {
- /**
- *
- */
private final Long id;
-
- /**
- *
- */
+
private final String name;
-
+
/**
+ * Constructor.
*
+ * @param id Id.
*/
public CustomTuple(Long id) {
this(id, null);
}
/**
+ * Constructor.
*
+ * @param id Id.
+ * @param name Name.
*/
public CustomTuple(Long id, String name) {
this.id = id;
this.name = name;
}
-
+
+ /** {@inheritDoc} */
@Override
public int columnCount() {
return 2;
}
-
+
+ /** {@inheritDoc} */
@Override
public String columnName(int columnIndex) {
switch (columnIndex) {
@@ -75,7 +76,8 @@ public class CustomTuple implements Tuple {
return null;
}
-
+
+ /** {@inheritDoc} */
@Override
public int columnIndex(@NotNull String columnName) {
switch (columnName) {
@@ -89,7 +91,8 @@ public class CustomTuple implements Tuple {
return -1;
}
-
+
+ /** {@inheritDoc} */
@Override
public <T> T valueOrDefault(@NotNull String columnName, T def) {
switch (columnName) {
@@ -103,17 +106,20 @@ public class CustomTuple implements Tuple {
return def;
}
-
+
+ /** {@inheritDoc} */
@Override
public Tuple set(@NotNull String columnName, Object value) {
throw new UnsupportedOperationException("Tuple is immutable.");
}
-
+
+ /** {@inheritDoc} */
@Override
public <T> T value(@NotNull String columnName) {
return valueOrDefault(columnName, null);
}
-
+
+ /** {@inheritDoc} */
@Override
public <T> T value(int columnIndex) {
switch (columnIndex) {
@@ -127,158 +133,189 @@ public class CustomTuple implements Tuple {
return null;
}
-
+
+ /** {@inheritDoc} */
@Override
public BinaryObject binaryObjectValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public BinaryObject binaryObjectValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public byte byteValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public byte byteValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public short shortValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public short shortValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public int intValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public int intValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public long longValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public long longValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public float floatValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public float floatValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public double doubleValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public double doubleValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public String stringValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public String stringValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public UUID uuidValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public UUID uuidValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public BitSet bitmaskValue(@NotNull String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public BitSet bitmaskValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public LocalDate dateValue(String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public LocalDate dateValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public LocalTime timeValue(String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public LocalTime timeValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public LocalDateTime datetimeValue(String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public LocalDateTime datetimeValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public Instant timestampValue(String columnName) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@Override
public Instant timestampValue(int columnIndex) {
throw new UnsupportedOperationException();
}
-
+
+ /** {@inheritDoc} */
@NotNull
@Override
public Iterator<Object> iterator() {
throw new UnsupportedOperationException();
}
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return Tuple.hashCode(this);
}
+ /** {@inheritDoc} */
@Override
public boolean equals(Object obj) {
if (this == obj) {
diff --git a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeCursor.java b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeCursor.java
index f32c6a1..5bcb350 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeCursor.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeCursor.java
@@ -26,8 +26,10 @@ import org.apache.ignite.internal.processors.query.calcite.ResultSetMetadata;
import org.apache.ignite.internal.processors.query.calcite.SqlCursor;
import org.apache.ignite.internal.processors.query.calcite.SqlQueryType;
+/**
+ * Fake {@link SqlCursor}.
+ */
public class FakeCursor implements SqlCursor<List<?>> {
-
private final Random random;
FakeCursor() {
diff --git a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgnite.java b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgnite.java
index ecd3464..19b8656 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgnite.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgnite.java
@@ -33,10 +33,7 @@ public class FakeIgnite implements Ignite {
public FakeIgnite() {
super();
}
-
- /**
- *
- */
+
private final IgniteTables tables = new FakeIgniteTables();
/** {@inheritDoc} */
diff --git a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteQueryProcessor.java b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteQueryProcessor.java
index 2ba9ac9..081a4e0 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteQueryProcessor.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteQueryProcessor.java
@@ -22,6 +22,9 @@ import java.util.List;
import org.apache.ignite.internal.processors.query.calcite.QueryProcessor;
import org.apache.ignite.internal.processors.query.calcite.SqlCursor;
+/**
+ * Fake {@link QueryProcessor}.
+ */
public class FakeIgniteQueryProcessor implements QueryProcessor {
@Override
public List<SqlCursor<List<?>>> query(String schemaName, String qry, Object... params) {
diff --git a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteTables.java b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteTables.java
index a4a79ca..4e8f62b 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteTables.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeIgniteTables.java
@@ -39,19 +39,10 @@ import org.jetbrains.annotations.NotNull;
* Fake tables.
*/
public class FakeIgniteTables implements IgniteTables, IgniteTablesInternal {
- /**
- *
- */
public static final String TABLE_EXISTS = "Table exists";
- /**
- *
- */
private final ConcurrentHashMap<String, TableImpl> tables = new ConcurrentHashMap<>();
- /**
- *
- */
private final ConcurrentHashMap<IgniteUuid, TableImpl> tablesById = new ConcurrentHashMap<>();
/** {@inheritDoc} */
diff --git a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeSchemaRegistry.java b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeSchemaRegistry.java
index ff6d9ab..52cbad5 100644
--- a/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeSchemaRegistry.java
+++ b/modules/client/src/test/java/org/apache/ignite/client/fakes/FakeSchemaRegistry.java
@@ -51,7 +51,7 @@ public class FakeSchemaRegistry implements SchemaRegistry {
}
/**
- * Sets the last schema version
+ * Sets the last schema version.
*
* @param lastVer Last schema version.
*/
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNode.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNode.java
index 67440ea..a6a1cc8 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNode.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNode.java
@@ -18,13 +18,15 @@
package org.apache.ignite.internal.configuration.tree;
/**
- *
+ * An interface for traversing a tree.
*/
public interface TraversableTreeNode {
/**
- * @param key Name of the node retrieved from its holder object.
+ * Accept the visitor.
+ *
+ * @param key Name of the node retrieved from its holder object.
* @param visitor Configuration visitor.
- * @param <T> Parameter type of the passed visitor.
+ * @param <T> Parameter type of the passed visitor.
* @return Whatever {@code visitor} returned.
*/
<T> T accept(String key, ConfigurationVisitor<T> visitor);
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationNotificationsUtil.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationNotificationsUtil.java
index bffe83f..784c7be 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationNotificationsUtil.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationNotificationsUtil.java
@@ -46,7 +46,7 @@ import org.apache.ignite.internal.configuration.tree.NamedListNode;
import org.jetbrains.annotations.Nullable;
/**
- *
+ * Utility class for notifying a configuration update.
*/
public class ConfigurationNotificationsUtil {
/**
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationUtil.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationUtil.java
index 5710349..6345404 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationUtil.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/ConfigurationUtil.java
@@ -65,7 +65,7 @@ import org.apache.ignite.internal.configuration.tree.TraversableTreeNode;
import org.jetbrains.annotations.Nullable;
/**
- *
+ * Utility class for configuration.
*/
public class ConfigurationUtil {
/** Configuration source that copies values without modifying tham. */
@@ -364,6 +364,8 @@ public class ConfigurationUtil {
}
/**
+ * Returns visitor that returns leaf value or {@code null} if node is not a leaf.
+ *
* @return Visitor that returns leaf value or {@code null} if node is not a leaf.
*/
public static ConfigurationVisitor<Serializable> leafNodeVisitor() {
@@ -376,6 +378,8 @@ public class ConfigurationUtil {
}
/**
+ * Returns visitor that returns inner node or {@code null} if node is not an inner node.
+ *
* @return Visitor that returns inner node or {@code null} if node is not an inner node.
*/
public static ConfigurationVisitor<InnerNode> innerNodeVisitor() {
@@ -388,6 +392,8 @@ public class ConfigurationUtil {
}
/**
+ * Returns visitor that returns named list node or {@code null} if node is not a named list node.
+ *
* @return Visitor that returns named list node or {@code null} if node is not a named list node.
*/
public static ConfigurationVisitor<NamedListNode<?>> namedListNodeVisitor() {
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeyNotFoundException.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeyNotFoundException.java
index ee01e2e..33dae93 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeyNotFoundException.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeyNotFoundException.java
@@ -18,13 +18,15 @@
package org.apache.ignite.internal.configuration.util;
/**
- *
+ * Thrown when the configuration key is unknown.
*/
public class KeyNotFoundException extends RuntimeException {
/** Serial version uid. */
private static final long serialVersionUID = 0L;
/**
+ * Constructor.
+ *
* @param msg Message.
*/
public KeyNotFoundException(String msg) {
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeysTrackingConfigurationVisitor.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeysTrackingConfigurationVisitor.java
index c46a31c..af52c63 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeysTrackingConfigurationVisitor.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/util/KeysTrackingConfigurationVisitor.java
@@ -135,6 +135,8 @@ public abstract class KeysTrackingConfigurationVisitor<T> implements Configurati
}
/**
+ * Returns current key, with a dot at the end if it's not a leaf.
+ *
* @return Current key, with a dot at the end if it's not a leaf.
*/
protected final String currentKey() {
@@ -142,6 +144,8 @@ public abstract class KeysTrackingConfigurationVisitor<T> implements Configurati
}
/**
+ * Returns list representation of the current key.
+ *
* @return List representation of the current key.
*/
protected final List<String> currentPath() {
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ImmutableValidator.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ImmutableValidator.java
index 6912274..ec6665f 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ImmutableValidator.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ImmutableValidator.java
@@ -23,6 +23,9 @@ import org.apache.ignite.configuration.validation.ValidationContext;
import org.apache.ignite.configuration.validation.ValidationIssue;
import org.apache.ignite.configuration.validation.Validator;
+/**
+ * Implementing a validator for {@link Immutable}.
+ */
public class ImmutableValidator implements Validator<Immutable, Object> {
/** {@inheritDoc} */
@Override
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationContextImpl.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationContextImpl.java
index 52064ee..57b824a 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationContextImpl.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationContextImpl.java
@@ -49,19 +49,13 @@ class ValidationContextImpl<VIEWT> implements ValidationContext<VIEWT> {
*/
private final VIEWT val;
- /**
- *
- */
+ /** Key corresponding to the value. */
private final String currentKey;
- /**
- *
- */
+ /** List representation of {@link #currentKey}. */
private final List<String> currentPath;
- /**
- *
- */
+ /** List of issues, should be used as a write-only collection. */
private final List<ValidationIssue> issues;
/**
diff --git a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationUtil.java b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationUtil.java
index 307ed1a..df253ed 100644
--- a/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationUtil.java
+++ b/modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationUtil.java
@@ -39,7 +39,7 @@ import org.apache.ignite.internal.configuration.util.AnyNodeConfigurationVisitor
import org.apache.ignite.internal.configuration.util.KeysTrackingConfigurationVisitor;
/**
- *
+ * Utility class for configuration validation.
*/
public class ValidationUtil {
/**
@@ -143,10 +143,7 @@ public class ValidationUtil {
return issues;
}
-
- /**
- *
- */
+
private static boolean assertValidatorTypesCoherence(
Class<?> validatorClass,
Class<? extends Annotation> annotationType,
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationChangerTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationChangerTest.java
index 7c76340..da707bf 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationChangerTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationChangerTest.java
@@ -71,66 +71,44 @@ public class ConfigurationChangerTest {
}
/**
- *
+ * First configuration schema.
*/
@ConfigurationRoot(rootName = "key", type = LOCAL)
public static class FirstConfigurationSchema {
- /**
- *
- */
@ConfigValue
@MaybeInvalid
public SecondConfigurationSchema child;
- /**
- *
- */
@NamedConfigValue
public ThirdConfigurationSchema elements;
}
/**
- *
+ * Second configuration schema.
*/
@Config
public static class SecondConfigurationSchema {
- /**
- *
- */
@Value
@Immutable
public int intCfg;
- /**
- *
- */
@Value
public String strCfg;
}
/**
- *
+ * Third configuration schema.
*/
@Config
public static class ThirdConfigurationSchema {
- /**
- *
- */
@Value
public String strCfg;
}
- /**
- *
- */
private static ConfigurationAsmGenerator cgen = new ConfigurationAsmGenerator();
- /** Test storage. */
private final TestConfigurationStorage storage = new TestConfigurationStorage(LOCAL);
- /**
- *
- */
@AfterAll
public static void afterAll() {
cgen = null;
@@ -276,43 +254,28 @@ public class ConfigurationChangerTest {
}
/**
- *
+ * Configuration schema with default values for children.
*/
@ConfigurationRoot(rootName = "def", type = LOCAL)
public static class DefaultsConfigurationSchema {
- /**
- *
- */
@ConfigValue
public DefaultsChildConfigurationSchema child;
- /**
- *
- */
@NamedConfigValue
public DefaultsChildConfigurationSchema childrenList;
- /**
- *
- */
@Value(hasDefault = true)
public String defStr = "foo";
}
/**
- *
+ * Configuration schema with default values for children.
*/
@Config
public static class DefaultsChildConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
public String defStr = "bar";
- /**
- *
- */
@Value(hasDefault = true)
public String[] arr = {"xyz"};
}
@@ -503,9 +466,6 @@ public class ConfigurationChangerTest {
assertThat(e.getMessage(), containsString("def.childrenList.name.defStr"));
}
- /**
- *
- */
private static <CHANGET> ConfigurationSource source(RootKey<?, ? super CHANGET> rootKey, Consumer<CHANGET> changer) {
return new ConfigurationSource() {
@Override
@@ -522,9 +482,6 @@ public class ConfigurationChangerTest {
};
}
- /**
- *
- */
private ConfigurationChanger createChanger(RootKey<?, ?> rootKey) {
return new TestConfigurationChanger(cgen, List.of(rootKey), Map.of(), storage, List.of(), List.of());
}
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationRegistryTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationRegistryTest.java
index 5e667dc..2228915 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationRegistryTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/ConfigurationRegistryTest.java
@@ -36,9 +36,6 @@ import org.junit.jupiter.api.Test;
* Class for testing the {@link ConfigurationRegistry}.
*/
public class ConfigurationRegistryTest {
- /**
- *
- */
@Test
void testValidationInternalConfigurationExtensions() {
assertThrows(
@@ -64,9 +61,6 @@ public class ConfigurationRegistryTest {
configRegistry.stop();
}
- /**
- *
- */
@Test
void testValidationPolymorphicConfigurationExtensions() {
// There is a polymorphic extension that is missing from the schema.
@@ -146,7 +140,7 @@ public class ConfigurationRegistryTest {
*/
@ConfigurationRoot(rootName = "third")
public static class ThirdRootConfigurationSchema {
- /** First polymorphic configuration scheme */
+ /** First polymorphic configuration scheme. */
@ConfigValue
public FirstPolymorphicConfigurationSchema polymorphicConfig;
}
@@ -156,7 +150,7 @@ public class ConfigurationRegistryTest {
*/
@ConfigurationRoot(rootName = "fourth")
public static class FourthRootConfigurationSchema {
- /** Second polymorphic configuration scheme */
+ /** Second polymorphic configuration scheme. */
@ConfigValue
public SecondPolymorphicConfigurationSchema polymorphicConfig;
}
@@ -166,7 +160,7 @@ public class ConfigurationRegistryTest {
*/
@ConfigurationRoot(rootName = "fifth")
public static class FifthRootConfigurationSchema {
- /** Third polymorphic configuration scheme */
+ /** Third polymorphic configuration scheme. */
@ConfigValue
public ThirdPolymorphicConfigurationSchema polymorphicConfig;
}
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/DirectPropertiesTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/DirectPropertiesTest.java
index efefd3a..0c5300a 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/DirectPropertiesTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/DirectPropertiesTest.java
@@ -53,86 +53,56 @@ import org.junit.jupiter.api.Test;
*/
public class DirectPropertiesTest {
/**
- *
+ * Direct root configuration schema.
*/
@ConfigurationRoot(rootName = "root")
@DirectAccess
public static class DirectConfigurationSchema {
- /**
- *
- */
@ConfigValue
public DirectNestedConfigurationSchema child;
- /**
- *
- */
@NamedConfigValue
public DirectNestedConfigurationSchema childrenList;
- /**
- *
- */
@Value(hasDefault = true)
@DirectAccess
public String directStr = "foo";
- /**
- *
- */
@Value(hasDefault = true)
public String nonDirectStr = "bar";
}
/**
- *
+ * Direct nested configuration schema.
*/
@Config
@DirectAccess
public static class DirectNestedConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
@DirectAccess
public String str = "bar";
- /**
- *
- */
@Value(hasDefault = true)
public String nonDirectStr = "bar";
- /**
- *
- */
@NamedConfigValue
public DirectNested2ConfigurationSchema childrenList2;
}
/**
- *
+ * Direct nested 2 configuration schema.
*/
@Config
@DirectAccess
public static class DirectNested2ConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
@DirectAccess
public String str = "bar";
- /**
- *
- */
@Value(hasDefault = true)
public String nonDirectStr = "bar";
}
- /**
- *
- */
private final ConfigurationRegistry registry = new ConfigurationRegistry(
List.of(DirectConfiguration.KEY),
Map.of(),
@@ -141,9 +111,6 @@ public class DirectPropertiesTest {
List.of()
);
- /**
- *
- */
@BeforeEach
void setUp() {
registry.start();
@@ -151,9 +118,6 @@ public class DirectPropertiesTest {
registry.initializeDefaults();
}
- /**
- *
- */
@AfterEach
void tearDown() {
registry.stop();
@@ -207,7 +171,9 @@ public class DirectPropertiesTest {
}
/**
- * Tests the following scenario:
+ * Test for named list configuration.
+ *
+ * <p>Tests the following scenario:
* <ol>
* <li>A Named List element is created. Both "direct" and regular properties must be the same.</li>
* <li>The element is removed. Both "direct" and regular properties must not return any values
@@ -247,9 +213,6 @@ public class DirectPropertiesTest {
assertThat(directValue(childCfg.str()), is("bar"));
}
- /**
- *
- */
@Test
void testDirectAccessForAny() {
NamedConfigurationTree<DirectNestedConfiguration, DirectNestedView, DirectNestedChange> childrenList =
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/asm/ConfigurationAsmGeneratorTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/asm/ConfigurationAsmGeneratorTest.java
index fdeb7af..5a894a4 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/asm/ConfigurationAsmGeneratorTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/asm/ConfigurationAsmGeneratorTest.java
@@ -64,25 +64,16 @@ public class ConfigurationAsmGeneratorTest {
/** Configuration changer. */
private ConfigurationChanger changer;
- /**
- *
- */
@BeforeAll
public static void beforeAll() {
generator = new ConfigurationAsmGenerator();
}
- /**
- *
- */
@AfterAll
public static void afterAll() {
generator = null;
}
- /**
- *
- */
@BeforeEach
void beforeEach() {
Collection<Class<?>> internalExtensions = List.of(
@@ -112,17 +103,11 @@ public class ConfigurationAsmGeneratorTest {
changer.initializeDefaults();
}
- /**
- *
- */
@AfterEach
void afterEach() {
changer.stop();
}
- /**
- *
- */
@Test
void testInternalRootConfiguration() throws Exception {
DynamicConfiguration<?, ?> config = generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -166,9 +151,6 @@ public class ConfigurationAsmGeneratorTest {
}).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testInternalSubConfiguration() throws Exception {
DynamicConfiguration<?, ?> config = generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -209,9 +191,6 @@ public class ConfigurationAsmGeneratorTest {
}).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testInternalNamedConfiguration() throws Exception {
DynamicConfiguration<?, ?> config = generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -243,9 +222,6 @@ public class ConfigurationAsmGeneratorTest {
}).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testConstructInternalConfig() {
InnerNode innerNode = generator.instantiateNode(TestRootConfiguration.KEY.schemaClass());
@@ -271,9 +247,6 @@ public class ConfigurationAsmGeneratorTest {
subInnerNode.construct("i1", null, true);
}
- /**
- *
- */
@Test
void testPolymorphicSubConfiguration() throws Exception {
TestRootConfiguration rootConfig = (TestRootConfiguration) generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -342,9 +315,6 @@ public class ConfigurationAsmGeneratorTest {
assertEquals(0, firstCfg.intVal().value());
}
- /**
- *
- */
@Test
void testPolymorphicErrors() throws Exception {
TestRootConfiguration rootConfig = (TestRootConfiguration) generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -380,9 +350,6 @@ public class ConfigurationAsmGeneratorTest {
);
}
- /**
- *
- */
@Test
void testPolymorphicNamedConfigurationAdd() throws Exception {
TestRootConfiguration rootConfig = (TestRootConfiguration) generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -446,9 +413,6 @@ public class ConfigurationAsmGeneratorTest {
assertEquals(1L, secondVal.longVal());
}
- /**
- *
- */
@Test
void testPolymorphicNamedConfigurationChange() throws Exception {
TestRootConfiguration rootConfig = (TestRootConfiguration) generator.instantiateCfg(TestRootConfiguration.KEY, changer);
@@ -487,9 +451,6 @@ public class ConfigurationAsmGeneratorTest {
assertEquals("strVal3", secondCfg.strVal().value());
}
- /**
- *
- */
@Test
void testPolymorphicNamedConfigurationRemove() throws Exception {
TestRootConfiguration rootConfig = (TestRootConfiguration) generator.instantiateCfg(TestRootConfiguration.KEY, changer);
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/hocon/HoconConverterTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/hocon/HoconConverterTest.java
index 6adef9f..f435a00 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/hocon/HoconConverterTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/hocon/HoconConverterTest.java
@@ -57,19 +57,13 @@ import org.junit.jupiter.api.function.Executable;
*/
public class HoconConverterTest {
/**
- *
+ * Hocon root configuration schema.
*/
@ConfigurationRoot(rootName = "root", type = LOCAL)
public static class HoconRootConfigurationSchema {
- /**
- *
- */
@NamedConfigValue(syntheticKeyName = "a")
public HoconArraysConfigurationSchema arraysList;
- /**
- *
- */
@NamedConfigValue(syntheticKeyName = "p")
public HoconPrimitivesConfigurationSchema primitivesList;
@@ -83,57 +77,30 @@ public class HoconConverterTest {
*/
@Config
public static class HoconArraysConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
public boolean[] booleans = {false};
- /**
- *
- */
@Value(hasDefault = true)
public byte[] bytes = {0};
- /**
- *
- */
@Value(hasDefault = true)
public short[] shorts = {0};
- /**
- *
- */
@Value(hasDefault = true)
public int[] ints = {0};
- /**
- *
- */
@Value(hasDefault = true)
public long[] longs = {0L};
- /**
- *
- */
@Value(hasDefault = true)
public char[] chars = {0};
- /**
- *
- */
@Value(hasDefault = true)
public float[] floats = {0};
- /**
- *
- */
@Value(hasDefault = true)
public double[] doubles = {0};
- /**
- *
- */
@Value(hasDefault = true)
public String[] strings = {""};
}
@@ -143,57 +110,30 @@ public class HoconConverterTest {
*/
@Config
public static class HoconPrimitivesConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
public boolean booleanVal = false;
- /**
- *
- */
@Value(hasDefault = true)
public byte byteVal = 0;
- /**
- *
- */
@Value(hasDefault = true)
public short shortVal = 0;
- /**
- *
- */
@Value(hasDefault = true)
public int intVal = 0;
- /**
- *
- */
@Value(hasDefault = true)
public long longVal = 0L;
- /**
- *
- */
@Value(hasDefault = true)
public char charVal = 0;
- /**
- *
- */
@Value(hasDefault = true)
public float floatVal = 0;
- /**
- *
- */
@Value(hasDefault = true)
public double doubleVal = 0;
- /**
- *
- */
@Value(hasDefault = true)
public String stringVal = "";
}
@@ -228,18 +168,12 @@ public class HoconConverterTest {
public int intVal = 0;
}
- /**
- *
- */
private static ConfigurationRegistry registry;
- /**
- *
- */
private static HoconRootConfiguration configuration;
/**
- *
+ * Before all.
*/
@BeforeAll
public static void beforeAll() {
@@ -260,7 +194,7 @@ public class HoconConverterTest {
}
/**
- *
+ * After all.
*/
@AfterAll
public static void after() {
@@ -272,7 +206,7 @@ public class HoconConverterTest {
}
/**
- *
+ * Before each.
*/
@BeforeEach
public void before() throws Exception {
@@ -284,9 +218,6 @@ public class HoconConverterTest {
).get(1, SECONDS);
}
- /**
- *
- */
@Test
public void toHoconBasic() {
assertEquals("root{arraysList=[],polymorphicCfg{longVal=0,typeId=first},primitivesList=[]}", asHoconStr(List.of()));
@@ -379,9 +310,6 @@ public class HoconConverterTest {
return hoconCfg.render(ConfigRenderOptions.concise().setJson(false));
}
- /**
- *
- */
@Test
public void fromHoconBasic() {
// Wrong names:
@@ -651,9 +579,6 @@ public class HoconConverterTest {
);
}
- /**
- *
- */
@Test
void testPolymorphicConfig() throws Throwable {
// Check defaults.
@@ -693,9 +618,6 @@ public class HoconConverterTest {
}
}
- /**
- *
- */
private static void assertThrowsIllegalArgException(Executable executable, String msg) {
IllegalArgumentException e = assertThrows(IllegalArgumentException.class, executable);
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationAnyListenerTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationAnyListenerTest.java
index e66f9f1..fbdfcdb 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationAnyListenerTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationAnyListenerTest.java
@@ -107,7 +107,7 @@ public class ConfigurationAnyListenerTest {
private final List<String> events = new ArrayList<>();
/**
- *
+ * Before each.
*/
@BeforeEach
public void before() throws Exception {
@@ -188,17 +188,11 @@ public class ConfigurationAnyListenerTest {
childCfg.elements2().any().intVal().listen(configListener(ctx -> events.add("root.elements.0.elements2.any.i")));
}
- /**
- *
- */
@AfterEach
public void after() {
registry.stop();
}
- /**
- *
- */
@Test
void testNoGetOrUpdateConfigValueForAny() throws Exception {
FirstSubConfiguration any0 = rootConfig.elements().any();
@@ -238,9 +232,6 @@ public class ConfigurationAnyListenerTest {
assertThrows(ConfigurationListenOnlyException.class, () -> any2.intVal().update(300));
}
- /**
- *
- */
@Test
void testNoAnyListenerNotification() throws Exception {
checkEqualsListeners(
@@ -255,10 +246,7 @@ public class ConfigurationAnyListenerTest {
events
);
}
-
- /**
- *
- */
+
@Test
void testAnyListenerNotificationOnCreate() throws Exception {
checkEqualsListeners(
@@ -324,9 +312,6 @@ public class ConfigurationAnyListenerTest {
);
}
- /**
- *
- */
@Test
void testAnyListenerNotificationOnRename() throws Exception {
checkEqualsListeners(
@@ -367,9 +352,6 @@ public class ConfigurationAnyListenerTest {
);
}
- /**
- *
- */
@Test
void testAnyListenerNotificationOnDelete() throws Exception {
checkEqualsListeners(
@@ -414,9 +396,6 @@ public class ConfigurationAnyListenerTest {
);
}
- /**
- *
- */
@Test
void testAnyListenerNotificationForLeaf() throws Exception {
checkEqualsListeners(
@@ -482,9 +461,6 @@ public class ConfigurationAnyListenerTest {
);
}
- /**
- *
- */
@Test
void testAnyStopListen() throws Exception {
ConfigurationListener<FirstSubView> listener0 = configListener(ctx -> events.add("root.elements.any2"));
@@ -518,9 +494,6 @@ public class ConfigurationAnyListenerTest {
);
}
- /**
- *
- */
@Test
void testAnyGetConfigFromNotificationEventOnCreate() throws Exception {
String key0 = UUID.randomUUID().toString();
@@ -552,9 +525,6 @@ public class ConfigurationAnyListenerTest {
rootConfig.elements().get(key0).elements2().change(c -> c.create(key1, doNothingConsumer())).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testAnyGetConfigFromNotificationEventOnRename() throws Exception {
String key0 = UUID.randomUUID().toString();
@@ -589,9 +559,6 @@ public class ConfigurationAnyListenerTest {
rootConfig.elements().get(key0).elements2().change(c -> c.rename(oldKey1, newKey1)).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testAnyGetConfigFromNotificationEventOnDelete() throws Exception {
String key0 = UUID.randomUUID().toString();
@@ -641,9 +608,6 @@ public class ConfigurationAnyListenerTest {
rootConfig.elements().get(key0).elements2().change(c -> c.delete(key1)).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testAnyGetConfigFromNotificationEventOnUpdate() throws Exception {
String key0 = UUID.randomUUID().toString();
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTest.java
index 54a9a50..ceab2cb 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTest.java
@@ -55,51 +55,36 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- *
+ * Test class for configuration listener.
*/
public class ConfigurationListenerTest {
/**
- *
+ * Parent root configuration schema.
*/
@ConfigurationRoot(rootName = "parent", type = LOCAL)
public static class ParentConfigurationSchema {
- /**
- *
- */
@ConfigValue
public ChildConfigurationSchema child;
- /**
- *
- */
@NamedConfigValue
public ChildConfigurationSchema elements;
}
/**
- *
+ * Child configuration schema.
*/
@Config
public static class ChildConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
public String str = "default";
}
- /**
- *
- */
private ConfigurationRegistry registry;
- /**
- *
- */
private ParentConfiguration configuration;
/**
- *
+ * Before each.
*/
@BeforeEach
public void before() {
@@ -120,17 +105,11 @@ public class ConfigurationListenerTest {
configuration = registry.getConfiguration(ParentConfiguration.KEY);
}
- /**
- *
- */
@AfterEach
public void after() {
registry.stop();
}
- /**
- *
- */
@Test
public void childNode() throws Exception {
List<String> log = new ArrayList<>();
@@ -702,9 +681,6 @@ public class ConfigurationListenerTest {
assertEquals(List.of("deleted"), log);
}
- /**
- *
- */
@Test
void testStopListen() throws Exception {
List<String> events = new ArrayList<>();
@@ -751,9 +727,6 @@ public class ConfigurationListenerTest {
);
}
- /**
- *
- */
@Test
void testGetConfigFromNotificationEvent() throws Exception {
String newVal = UUID.randomUUID().toString();
@@ -792,9 +765,6 @@ public class ConfigurationListenerTest {
configuration.change(c0 -> c0.changeChild(c1 -> c1.changeStr(newVal))).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testGetConfigFromNotificationEventOnCreate() throws Exception {
String newVal = UUID.randomUUID().toString();
@@ -827,9 +797,6 @@ public class ConfigurationListenerTest {
configuration.elements().change(c -> c.create(key, c1 -> c1.changeStr(newVal))).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testGetConfigFromNotificationEventOnRename() throws Exception {
String val = "default";
@@ -866,9 +833,6 @@ public class ConfigurationListenerTest {
configuration.elements().change(c -> c.rename(oldKey, newKey));
}
- /**
- *
- */
@Test
void testGetConfigFromNotificationEventOnDelete() throws Exception {
String key = UUID.randomUUID().toString();
@@ -906,9 +870,6 @@ public class ConfigurationListenerTest {
configuration.elements().change(c -> c.delete(key)).get(1, SECONDS);
}
- /**
- *
- */
@Test
void testGetConfigFromNotificationEventOnUpdate() throws Exception {
String newVal = UUID.randomUUID().toString();
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTestUtils.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTestUtils.java
index d07376a..70bccf5 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTestUtils.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/notifications/ConfigurationListenerTestUtils.java
@@ -44,6 +44,8 @@ class ConfigurationListenerTestUtils {
}
/**
+ * Returns consumer who does nothing.
+ *
* @return Consumer who does nothing.
*/
static <T> Consumer<T> doNothingConsumer() {
@@ -52,6 +54,8 @@ class ConfigurationListenerTestUtils {
}
/**
+ * Returns config value change listener.
+ *
* @param consumer Consumer of the notification context.
* @return Config value change listener.
*/
@@ -116,6 +120,8 @@ class ConfigurationListenerTestUtils {
}
/**
+ * Returns named config value change listener.
+ *
* @param consumer Consumer of the notification context.
* @return Named config value change listener.
*/
@@ -138,6 +144,8 @@ class ConfigurationListenerTestUtils {
}
/**
+ * Returns named config value change listener.
+ *
* @param consumer Consumer of the notification context.
* @return Named config value change listener.
*/
@@ -164,6 +172,8 @@ class ConfigurationListenerTestUtils {
}
/**
+ * Returns named config value change listener.
+ *
* @param consumer Consumer of the notification context.
* @return Named config value change listener.
*/
@@ -186,6 +196,8 @@ class ConfigurationListenerTestUtils {
}
/**
+ * Returns named config value change listener.
+ *
* @param consumer Consumer of the notification context.
* @return Named config value change listener.
*/
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/BaselineConfigurationSchema.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/BaselineConfigurationSchema.java
index 611e9a5..bb969aa 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/BaselineConfigurationSchema.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/BaselineConfigurationSchema.java
@@ -26,7 +26,7 @@ import org.apache.ignite.configuration.annotation.NamedConfigValue;
*/
@Config
public class BaselineConfigurationSchema {
- /** Auto adjust */
+ /** Auto adjust. */
@ConfigValue
public AutoAdjustConfigurationSchema autoAdjust;
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/UsageTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/UsageTest.java
index f2f1803..c871420 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/UsageTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/sample/UsageTest.java
@@ -35,14 +35,8 @@ import org.junit.jupiter.api.Test;
* Simple usage test of generated configuration schema.
*/
public class UsageTest {
- /**
- *
- */
private ConfigurationRegistry registry;
- /**
- *
- */
@AfterEach
public void after() {
registry.stop();
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/BasicConfigurationSchema.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/BasicConfigurationSchema.java
index f27f652..6d54f75 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/BasicConfigurationSchema.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/BasicConfigurationSchema.java
@@ -25,9 +25,6 @@ import org.apache.ignite.configuration.annotation.Value;
*/
@Config
public class BasicConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
public int visible = 1;
}
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/ExtendedConfigurationSchema.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/ExtendedConfigurationSchema.java
index ec4b84e..0d1f42d 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/ExtendedConfigurationSchema.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/testframework/ExtendedConfigurationSchema.java
@@ -25,9 +25,6 @@ import org.apache.ignite.configuration.annotation.Value;
*/
@InternalConfiguration
public class ExtendedConfigurationSchema extends BasicConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
public int invisible = 2;
}
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConfigurationArrayTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConfigurationArrayTest.java
index 34146fc..d3ca018 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConfigurationArrayTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConfigurationArrayTest.java
@@ -40,81 +40,45 @@ import org.junit.jupiter.params.provider.MethodSource;
*/
public class ConfigurationArrayTest {
/**
- *
+ * Array configuration schema.
*/
@Config
public static class TestArrayConfigurationSchema {
- /**
- *
- */
@Value
public boolean[] booleanArray;
-
- /**
- *
- */
+
@Value
public byte[] byteArray;
-
- /**
- *
- */
+
@Value
public short[] shortArray;
-
- /**
- *
- */
+
@Value
public int[] intArray;
-
- /**
- *
- */
+
@Value
public long[] longArray;
-
- /**
- *
- */
+
@Value
public char[] charArray;
-
- /**
- *
- */
+
@Value
public float[] floatArray;
-
- /**
- *
- */
+
@Value
public double[] doubleArray;
-
- /**
- *
- */
+
@Value
public String[] stringArray;
}
-
- /**
- *
- */
+
private static ConfigurationAsmGenerator cgen = new ConfigurationAsmGenerator();
-
- /**
- *
- */
+
@BeforeAll
public static void beforeAll() {
cgen.compileRootSchema(TestArrayConfigurationSchema.class, Map.of(), Map.of());
}
-
- /**
- *
- */
+
@AfterAll
public static void afterAll() {
cgen = null;
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConstructableTreeNodeTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConstructableTreeNodeTest.java
index d594e2f..cce3ce5 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConstructableTreeNodeTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/ConstructableTreeNodeTest.java
@@ -32,18 +32,24 @@ import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
/**
- *
+ * Class for testing configuration construction.
*/
public class ConstructableTreeNodeTest {
private static ConfigurationAsmGenerator cgen;
-
+
+ /**
+ * Before all.
+ */
@BeforeAll
public static void beforeAll() {
cgen = new ConfigurationAsmGenerator();
cgen.compileRootSchema(TraversableTreeNodeTest.ParentConfigurationSchema.class, Map.of(), Map.of());
}
-
+
+ /**
+ * After all.
+ */
@AfterAll
public static void afterAll() {
cgen = null;
@@ -56,20 +62,14 @@ public class ConstructableTreeNodeTest {
public static <C extends InnerNode & ChildChange> C newChildInstance() {
return (C) cgen.instantiateNode(TraversableTreeNodeTest.ChildConfigurationSchema.class);
}
-
- /**
- *
- */
+
@Test
public void noKey() {
var childNode = newChildInstance();
assertThrows(NoSuchElementException.class, () -> childNode.construct("foo", null, true));
}
-
- /**
- *
- */
+
@Test
public void nullSource() {
var parentNode = newParentInstance();
@@ -105,15 +105,14 @@ public class ConstructableTreeNodeTest {
}
/**
- *
+ * Constant configuration source.
*/
private static class ConstantConfigurationSource implements ConfigurationSource {
- /**
- *
- */
private final Object constant;
/**
+ * Constructor.
+ *
* @param constant Constant.
*/
private ConstantConfigurationSource(Object constant) {
@@ -126,10 +125,7 @@ public class ConstructableTreeNodeTest {
return clazz.cast(constant);
}
}
-
- /**
- *
- */
+
@Test
public void unwrap() {
var childNode = newChildInstance();
@@ -146,10 +142,7 @@ public class ConstructableTreeNodeTest {
childNode.construct("intCfg", new ConstantConfigurationSource(new Object()), true)
);
}
-
- /**
- *
- */
+
@Test
public void descend() {
// Inner node.
@@ -187,9 +180,7 @@ public class ConstructableTreeNodeTest {
assertEquals("value", elementsNode.get("name").strCfg());
}
- /**
- *
- */
+
@Test
public void constructDefault() {
// Inner node with no leaves.
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/NamedListNodeTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/NamedListNodeTest.java
index 18d136e..e894b34 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/NamedListNodeTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/NamedListNodeTest.java
@@ -48,9 +48,6 @@ public class NamedListNodeTest {
/** Root that has a single named list. */
@ConfigurationRoot(rootName = "a")
public static class FirstConfigurationSchema {
- /**
- *
- */
@NamedConfigValue
public SecondConfigurationSchema second;
}
@@ -62,9 +59,6 @@ public class NamedListNodeTest {
@Value(hasDefault = true)
public String str = "foo";
- /**
- *
- */
@NamedConfigValue
public ThirdConfigurationSchema third;
}
@@ -99,7 +93,7 @@ public class NamedListNodeTest {
}
/**
- *
+ * Before each.
*/
@BeforeEach
public void before() {
@@ -118,7 +112,7 @@ public class NamedListNodeTest {
}
/**
- *
+ * After each.
*/
@AfterEach
public void after() {
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNodeTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNodeTest.java
index d98d6a8..799e862 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNodeTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/tree/TraversableTreeNodeTest.java
@@ -47,11 +47,14 @@ import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
/**
- *
+ * Class for testing configuration traversal.
*/
public class TraversableTreeNodeTest {
private static ConfigurationAsmGenerator cgen;
+ /**
+ * Before all.
+ */
@BeforeAll
public static void beforeAll() {
cgen = new ConfigurationAsmGenerator();
@@ -59,6 +62,9 @@ public class TraversableTreeNodeTest {
cgen.compileRootSchema(ParentConfigurationSchema.class, Map.of(), Map.of());
}
+ /**
+ * After all.
+ */
@AfterAll
public static void afterAll() {
cgen = null;
@@ -73,56 +79,41 @@ public class TraversableTreeNodeTest {
}
/**
- *
+ * Parent root configuration schema.
*/
@Config
public static class ParentConfigurationSchema {
- /**
- *
- */
@ConfigValue
public ChildConfigurationSchema child;
-
- /**
- *
- */
+
@NamedConfigValue
public NamedElementConfigurationSchema elements;
}
-
+
/**
- *
+ * Child configuration schema.
*/
@Config
public static class ChildConfigurationSchema {
- /**
- *
- */
@Value(hasDefault = true)
@Immutable
public int intCfg = 99;
-
- /**
- *
- */
+
@Value
public String strCfg;
}
-
+
/**
- *
+ * Child named configuration schema.
*/
@Config
public static class NamedElementConfigurationSchema {
- /**
- *
- */
@Value
public String strCfg;
}
/**
- *
+ * Visit exception.
*/
private static class VisitException extends RuntimeException {
/** Serial version uid. */
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/util/ConfigurationUtilTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/util/ConfigurationUtilTest.java
index 823aa62..bd70f19 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/util/ConfigurationUtilTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/util/ConfigurationUtilTest.java
@@ -81,11 +81,14 @@ import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
/**
- *
+ * Test class for {@link ConfigurationUtil}.
*/
public class ConfigurationUtilTest {
private static ConfigurationAsmGenerator cgen;
+ /**
+ * Before all.
+ */
@BeforeAll
public static void beforeAll() {
cgen = new ConfigurationAsmGenerator();
@@ -102,6 +105,9 @@ public class ConfigurationUtilTest {
);
}
+ /**
+ * After all.
+ */
@AfterAll
public static void afterAll() {
cgen = null;
@@ -118,9 +124,6 @@ public class ConfigurationUtilTest {
return (P) cgen.instantiateNode(schemaClass);
}
- /**
- *
- */
@Test
public void escape() {
assertEquals("foo", ConfigurationUtil.escape("foo"));
@@ -132,9 +135,6 @@ public class ConfigurationUtilTest {
assertEquals("\\\\a\\.b\\\\c\\.", ConfigurationUtil.escape("\\a.b\\c."));
}
- /**
- *
- */
@Test
public void unescape() {
assertEquals("foo", ConfigurationUtil.unescape("foo"));
@@ -146,54 +146,39 @@ public class ConfigurationUtilTest {
assertEquals("\\a.b\\c.", ConfigurationUtil.unescape("\\\\a\\.b\\\\c\\."));
}
- /**
- *
- */
@Test
public void split() {
assertEquals(List.of("a", "b.b", "c\\c", ""), ConfigurationUtil.split("a.b\\.b.c\\\\c."));
}
- /**
- *
- */
@Test
public void join() {
assertEquals("a.b\\.b.c\\\\c", ConfigurationUtil.join(List.of("a", "b.b", "c\\c")));
}
/**
- *
+ * Parent root configuration schema.
*/
@ConfigurationRoot(rootName = "root", type = LOCAL)
public static class ParentConfigurationSchema {
- /**
- *
- */
@NamedConfigValue
public NamedElementConfigurationSchema elements;
}
/**
- *
+ * Child named configuration schema.
*/
@Config
public static class NamedElementConfigurationSchema {
- /**
- *
- */
@ConfigValue
public ChildConfigurationSchema child;
}
/**
- *
+ * Child configuration schema.
*/
@Config
public static class ChildConfigurationSchema {
- /**
- *
- */
@Value
public String str;
}
@@ -291,7 +276,7 @@ public class ConfigurationUtilTest {
}
/**
- * Tests convertion of flat map to a prefix map.
+ * Tests conversion of flat map to a prefix map.
*/
@Test
public void toPrefixMap() {
@@ -416,9 +401,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testCheckConfigurationTypeMixedTypes() {
List<RootKey<?, ?>> rootKeys = List.of(LocalFirstConfiguration.KEY, DistributedFirstConfiguration.KEY);
@@ -434,9 +416,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testCheckConfigurationTypeOppositeTypes() {
assertThrows(
@@ -456,9 +435,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testCheckConfigurationTypeNoError() {
checkConfigurationType(
@@ -472,9 +448,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testInternalSchemaExtensions() {
assertTrue(internalSchemaExtensions(List.of()).isEmpty());
@@ -517,9 +490,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testSchemaFields() {
assertTrue(extensionsFields(List.of(), true).isEmpty());
@@ -553,9 +523,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testFindInternalConfigs() {
Map<Class<?>, Set<Class<?>>> internalExtensions = internalSchemaExtensions(List.of(
@@ -591,9 +558,6 @@ public class ConfigurationUtilTest {
assertEquals("foo", find(List.of("subCfg", "str02"), innerNode, true));
}
- /**
- *
- */
@Test
void testGetInternalConfigs() {
Map<Class<?>, Set<Class<?>>> internalExtensions = internalSchemaExtensions(List.of(
@@ -653,9 +617,6 @@ public class ConfigurationUtilTest {
assertEquals("foo", subConfig.get("str02"));
}
- /**
- *
- */
@Test
void testSuperRootWithInternalConfig() {
ConfigurationAsmGenerator generator = new ConfigurationAsmGenerator();
@@ -690,9 +651,6 @@ public class ConfigurationUtilTest {
assertNotNull(config.get(schemaKey.key()));
}
- /**
- *
- */
@Test
void testCollectSchemas() {
assertTrue(collectSchemas(List.of()).isEmpty());
@@ -718,9 +676,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testPolymorphicSchemaExtensions() {
assertTrue(polymorphicSchemaExtensions(List.of()).isEmpty());
@@ -743,9 +698,6 @@ public class ConfigurationUtilTest {
);
}
- /**
- *
- */
@Test
void testCompressDeletedEntries() {
Map<String, String> containsNullLeaf = new HashMap<>();
@@ -780,9 +732,6 @@ public class ConfigurationUtilTest {
assertEquals(exp, prefixMap);
}
- /**
- *
- */
@Test
void testFlattenedMapPolymorphicConfig() {
InnerNode polymorphicRootInnerNode = newNodeInstance(PolymorphicRootConfigurationSchema.class);
@@ -810,9 +759,6 @@ public class ConfigurationUtilTest {
assertEquals(exp, act);
}
- /**
- *
- */
@Test
void testFlattenedMapPolymorphicNamedConfig() {
InnerNode polymorphicRootInnerNode = newNodeInstance(PolymorphicRootConfigurationSchema.class);
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/OneOfValidatorTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/OneOfValidatorTest.java
index 3e0e039..56d729e 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/OneOfValidatorTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/OneOfValidatorTest.java
@@ -32,11 +32,11 @@ import org.junit.jupiter.params.provider.ValueSource;
import org.mockito.ArgumentCaptor;
/**
- *
+ * Test class for {@link OneOf}.
*/
public class OneOfValidatorTest {
/**
- *
+ * Test.
*/
@ParameterizedTest
@ValueSource(booleans = {false, true})
diff --git a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/ValidationUtilTest.java b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/ValidationUtilTest.java
index 568389c..fb1b9dc 100644
--- a/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/ValidationUtilTest.java
+++ b/modules/configuration/src/test/java/org/apache/ignite/internal/configuration/validation/ValidationUtilTest.java
@@ -48,87 +48,72 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- *
+ * Test class for {@link ValidationUtil}.
*/
public class ValidationUtilTest {
private static ConfigurationAsmGenerator cgen;
-
+
+ /**
+ * Before all.
+ */
@BeforeAll
public static void beforeAll() {
cgen = new ConfigurationAsmGenerator();
cgen.compileRootSchema(ValidatedRootConfigurationSchema.class, Map.of(), Map.of());
}
-
+
+ /**
+ * After all.
+ */
@AfterAll
public static void afterAll() {
cgen = null;
}
-
- /**
- *
- */
+
@Target(FIELD)
@Retention(RUNTIME)
@interface LeafValidation {
}
-
- /**
- *
- */
+
@Target(FIELD)
@Retention(RUNTIME)
@interface InnerValidation {
}
-
- /**
- *
- */
+
@Target(FIELD)
@Retention(RUNTIME)
@interface NamedListValidation {
}
-
+
/**
- *
+ * Root configuration schema.
*/
@ConfigurationRoot(rootName = "root", type = ConfigurationType.LOCAL)
public static class ValidatedRootConfigurationSchema {
- /**
- *
- */
@InnerValidation
@ConfigValue
public ValidatedChildConfigurationSchema child;
-
- /**
- *
- */
+
@NamedListValidation
@NamedConfigValue
public ValidatedChildConfigurationSchema elements;
}
/**
- *
+ * Child configuration schema.
*/
@Config
public static class ValidatedChildConfigurationSchema {
- /**
- *
- */
@LeafValidation
@Value(hasDefault = true)
public String str = "foo";
}
-
- /**
- *
- */
+
private InnerNode root;
/**
- *
+ * Before each.
*/
@BeforeEach
public void before() {
@@ -136,12 +121,9 @@ public class ValidationUtilTest {
ConfigurationUtil.addDefaults(root);
}
-
- /**
- *
- */
+
@Test
- public void validateLeafNode() throws Exception {
+ public void validateLeafNode() {
var rootsNode = new SuperRoot(key -> null, Map.of(ValidatedRootConfiguration.KEY, root));
Validator<LeafValidation, String> validator = new Validator<>() {
@@ -164,10 +146,7 @@ public class ValidationUtilTest {
assertEquals("bar", issues.get(0).message());
}
-
- /**
- *
- */
+
@Test
public void validateInnerNode() throws Exception {
var rootsNode = new SuperRoot(key -> null, Map.of(ValidatedRootConfiguration.KEY, root));
@@ -192,10 +171,7 @@ public class ValidationUtilTest {
assertEquals("bar", issues.get(0).message());
}
-
- /**
- *
- */
+
@Test
public void validateNamedListNode() throws Exception {
var rootsNode = new SuperRoot(key -> null, Map.of(ValidatedRootConfiguration.KEY, root));
diff --git a/modules/network-annotation-processor/src/integrationTest/java/org/apache/ignite/internal/network/processor/ItTransferableObjectProcessorTest.java b/modules/network-annotation-processor/src/integrationTest/java/org/apache/ignite/internal/network/processor/ItTransferableObjectProcessorTest.java
index 31feb7d..cb49947 100644
--- a/modules/network-annotation-processor/src/integrationTest/java/org/apache/ignite/internal/network/processor/ItTransferableObjectProcessorTest.java
+++ b/modules/network-annotation-processor/src/integrationTest/java/org/apache/ignite/internal/network/processor/ItTransferableObjectProcessorTest.java
@@ -251,10 +251,7 @@ public class ItTransferableObjectProcessorTest {
.map(JavaFileObjects::forResource)
.collect(Collectors.toList());
}
-
- /**
- *
- */
+
private static String fileName(String className) {
return RESOURCE_PACKAGE_NAME + className;
}
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageClass.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageClass.java
index b6d1d79..90470a8 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageClass.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageClass.java
@@ -51,7 +51,10 @@ public class MessageClass {
private final List<ExecutableElement> getters;
/**
- * @param messageElement element marked with the {@link Transferable} annotation.
+ * Constructor.
+ *
+ * @param processingEnv Processing environment.
+ * @param messageElement Element marked with the {@link Transferable} annotation.
*/
MessageClass(ProcessingEnvironment processingEnv, TypeElement messageElement) {
element = messageElement;
@@ -94,55 +97,71 @@ public class MessageClass {
}
/**
- * @return annotated element
+ * Returns annotated element.
+ *
+ * @return Annotated element.
*/
public TypeElement element() {
return element;
}
/**
- * @return class name of the {@link #element()}
+ * Returns class name of the {@link #element()}.
+ *
+ * @return Class name of the {@link #element()}.
*/
public ClassName className() {
return className;
}
/**
- * @return package name of the {@link #element()}
+ * Returns package name of the {@link #element()}.
+ *
+ * @return Package name of the {@link #element()}.
*/
public String packageName() {
return className.packageName();
}
/**
- * @return simple name of the {@link #element()}
+ * Returns simple name of the {@link #element()}.
+ *
+ * @return Simple name of the {@link #element()}.
*/
public String simpleName() {
return className.simpleName();
}
/**
- * @return getter methods declared in the annotated interface
+ * Returns getter methods declared in the annotated interface.
+ *
+ * @return Getter methods declared in the annotated interface.
*/
public List<ExecutableElement> getters() {
return getters;
}
/**
- * @return class name that the generated Network Message implementation should have
+ * Returns class name that the generated Network Message implementation should have.
+ *
+ * @return Class name that the generated Network Message implementation should have.
*/
public ClassName implClassName() {
return ClassName.get(packageName(), simpleName() + "Impl");
}
/**
- * @return class name that the generated Builder interface should have
+ * Returns class name that the generated Builder interface should have.
+ *
+ * @return Class name that the generated Builder interface should have.
*/
public ClassName builderClassName() {
return ClassName.get(packageName(), simpleName() + "Builder");
}
/**
+ * Returns name of the factory method that should be used by the message factories.
+ *
* @return name of the factory method that should be used by the message factories
*/
public String asMethodName() {
@@ -150,21 +169,27 @@ public class MessageClass {
}
/**
- * @return {@link Transferable#value()}
+ * Returns {@link Transferable#value()}.
+ *
+ * @return {@link Transferable#value()}.
*/
public short messageType() {
return annotation.value();
}
/**
- * @return {@link Transferable#autoSerializable()}
+ * Returns {@link Transferable#autoSerializable()}.
+ *
+ * @return {@link Transferable#autoSerializable()}.
*/
public boolean isAutoSerializable() {
return annotation.autoSerializable();
}
/**
- * @return a copy of the given string with the first character converted to lower case
+ * Returns a copy of the given string with the first character converted to lower case.
+ *
+ * @return A copy of the given string with the first character converted to lower case.
*/
private static String decapitalize(String str) {
return Character.toLowerCase(str.charAt(0)) + str.substring(1);
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageGroupWrapper.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageGroupWrapper.java
index 30b56fd..a9c2d6a 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageGroupWrapper.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/MessageGroupWrapper.java
@@ -25,7 +25,7 @@ import org.apache.ignite.network.annotations.MessageGroup;
* Wrapper around an element annotated with {@link MessageGroup}.
*/
public class MessageGroupWrapper {
- /** Message group element */
+ /** Message group element. */
private final TypeElement element;
/** Class name of the {@code element}. */
@@ -35,6 +35,8 @@ public class MessageGroupWrapper {
private final MessageGroup annotation;
/**
+ * Constructor.
+ *
* @param messageGroup element annotated with {@link MessageGroup}
*/
public MessageGroupWrapper(TypeElement messageGroup) {
@@ -48,35 +50,45 @@ public class MessageGroupWrapper {
}
/**
- * @return element that this class wraps
+ * Returns element that this class wraps.
+ *
+ * @return Element that this class wraps.
*/
public TypeElement element() {
return element;
}
/**
- * @return package name of the annotated element.
+ * Returns package name of the annotated element.
+ *
+ * @return Package name of the annotated element.
*/
public String packageName() {
return className.packageName();
}
/**
- * @return {@link MessageGroup#groupName()}
+ * Returns {@link MessageGroup#groupName()}.
+ *
+ * @return {@link MessageGroup#groupName()}.
*/
public String groupName() {
return capitalize(annotation.groupName());
}
/**
- * @return {@link MessageGroup#groupType()}
+ * Returns {@link MessageGroup#groupType()}.
+ *
+ * @return {@link MessageGroup#groupType()}.
*/
public short groupType() {
return annotation.groupType();
}
/**
- * @return class name of the message factory that should be generated for the current module.
+ * Returns class name of the message factory that should be generated for the current module.
+ *
+ * @return Class name of the message factory that should be generated for the current module.
*/
public ClassName messageFactoryClassName() {
return ClassName.get(packageName(), groupName() + "Factory");
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/ProcessingException.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/ProcessingException.java
index 3b9098b..040b7c7 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/ProcessingException.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/ProcessingException.java
@@ -24,13 +24,13 @@ import org.jetbrains.annotations.Nullable;
* Exception used by all annotation-processor related classes to gracefully display processing errors.
*/
public class ProcessingException extends RuntimeException {
- /**
- *
- */
+ /** Element which processing triggered the exception. */
@Nullable
private final Element element;
/**
+ * Constructor.
+ *
* @param message message
*/
public ProcessingException(String message) {
@@ -38,6 +38,8 @@ public class ProcessingException extends RuntimeException {
}
/**
+ * Constructor.
+ *
* @param message message
* @param cause cause
*/
@@ -46,6 +48,8 @@ public class ProcessingException extends RuntimeException {
}
/**
+ * Constructor.
+ *
* @param message message
* @param cause cause
* @param element element which processing triggered the exception
@@ -57,7 +61,9 @@ public class ProcessingException extends RuntimeException {
}
/**
- * @return element which processing triggered the exception
+ * Returns element which processing triggered the exception.
+ *
+ * @return Element which processing triggered the exception.
*/
@Nullable
public Element getElement() {
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TransferableObjectProcessor.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TransferableObjectProcessor.java
index 0685c89..a4550b1 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TransferableObjectProcessor.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TransferableObjectProcessor.java
@@ -94,7 +94,7 @@ public class TransferableObjectProcessor extends AbstractProcessor {
}
/**
- * Generates the following classes for the current compilation unit:
+ * Generates the following classes for the current compilation unit.
*
* <ol>
* <li>Builder interfaces;</li>
@@ -130,7 +130,7 @@ public class TransferableObjectProcessor extends AbstractProcessor {
}
/**
- * Generates the following classes for the current compilation unit:
+ * Generates the following classes for the current compilation unit.
*
* <ol>
* <li>{@link MessageSerializer};</li>
@@ -185,7 +185,7 @@ public class TransferableObjectProcessor extends AbstractProcessor {
}
/**
- * Validates the annotated messages:
+ * Validates the annotated messages.
*
* <ol>
* <li>{@link Transferable} annotation is present on a valid element;</li>
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TypeUtils.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TypeUtils.java
index 3618b6f..6ad59ce 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TypeUtils.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/TypeUtils.java
@@ -32,18 +32,14 @@ import org.jetbrains.annotations.Nullable;
* Various shortcuts over the {@link Types} utilities.
*/
public class TypeUtils {
- /**
- *
- */
private final Types types;
-
- /**
- *
- */
+
private final Elements elements;
/**
- * @param processingEnvironment processing environment
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
*/
public TypeUtils(ProcessingEnvironment processingEnvironment) {
this.types = processingEnvironment.getTypeUtils();
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageBuilderGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageBuilderGenerator.java
index 1a86456..650296e 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageBuilderGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageBuilderGenerator.java
@@ -33,17 +33,17 @@ import org.apache.ignite.internal.network.processor.MessageGroupWrapper;
* Class for generating Builder interfaces for Network Messages.
*/
public class MessageBuilderGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnvironment;
/** Message group. */
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnvironment processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
+ * @param messageGroup Message group.
*/
public MessageBuilderGenerator(ProcessingEnvironment processingEnvironment, MessageGroupWrapper messageGroup) {
this.processingEnvironment = processingEnvironment;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageFactoryGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageFactoryGenerator.java
index efd9fbf..2fe10e3 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageFactoryGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageFactoryGenerator.java
@@ -31,17 +31,17 @@ import org.apache.ignite.internal.network.processor.MessageGroupWrapper;
* Class for generating factories for Network Messages inside the given module.
*/
public class MessageFactoryGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnvironment;
/** Message group. */
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnvironment processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
+ * @param messageGroup Message group.
*/
public MessageFactoryGenerator(
ProcessingEnvironment processingEnvironment,
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageImplGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageImplGenerator.java
index 9c0575a..9694785 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageImplGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/messages/MessageImplGenerator.java
@@ -43,17 +43,17 @@ import org.apache.ignite.network.NetworkMessage;
* MessageBuilderGenerator}.
*/
public class MessageImplGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnv;
/** Message group. */
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnv processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnv Processing environment.
+ * @param messageGroup Message group.
*/
public MessageImplGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java
index 75e313f..00783d0 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java
@@ -39,13 +39,13 @@ import org.apache.ignite.network.NetworkMessage;
* @see MessageWriterMethodResolver
*/
class BaseMethodNameResolver {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnvironment;
/**
- * @param processingEnvironment processing environment
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
*/
BaseMethodNameResolver(ProcessingEnvironment processingEnvironment) {
this.processingEnvironment = processingEnvironment;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageCollectionItemTypeConverter.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageCollectionItemTypeConverter.java
index 974ae54..a0f6d80 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageCollectionItemTypeConverter.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageCollectionItemTypeConverter.java
@@ -34,13 +34,13 @@ import org.apache.ignite.plugin.extensions.communication.MessageCollectionItemTy
* Class for extracting {@link MessageCollectionItemType} from different type representations.
*/
class MessageCollectionItemTypeConverter {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnvironment;
/**
- * @param processingEnvironment processing environment
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
*/
MessageCollectionItemTypeConverter(ProcessingEnvironment processingEnvironment) {
this.processingEnvironment = processingEnvironment;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java
index 748a50c..8ea3d12 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java
@@ -38,9 +38,7 @@ import org.apache.ignite.network.serialization.MessageReader;
* Class for generating {@link MessageDeserializer} classes.
*/
public class MessageDeserializerGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnv;
/**
@@ -49,8 +47,10 @@ public class MessageDeserializerGenerator {
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnv processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnv Processing environment.
+ * @param messageGroup Message group.
*/
public MessageDeserializerGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java
index 14da216..8d746ae 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java
@@ -31,18 +31,16 @@ import org.apache.ignite.plugin.extensions.communication.MessageCollectionItemTy
* Class for resolving {@link MessageReader} "read*" methods for the corresponding message field type.
*/
class MessageReaderMethodResolver {
- /**
- *
- */
+ /** Method name resolver. */
private final BaseMethodNameResolver methodNameResolver;
- /**
- *
- */
+ /** Type converter. */
private final MessageCollectionItemTypeConverter typeConverter;
/**
- * @param processingEnvironment processing environment
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
*/
MessageReaderMethodResolver(ProcessingEnvironment processingEnvironment) {
methodNameResolver = new BaseMethodNameResolver(processingEnvironment);
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java
index 328a300..1926e8e 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java
@@ -38,17 +38,17 @@ import org.apache.ignite.network.serialization.MessageWriter;
* Class for generating {@link MessageSerializer} classes.
*/
public class MessageSerializerGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnvironment;
/** Message group. */
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnvironment processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
+ * @param messageGroup Message group.
*/
public MessageSerializerGenerator(ProcessingEnvironment processingEnvironment, MessageGroupWrapper messageGroup) {
this.processingEnvironment = processingEnvironment;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java
index dcfb18e..46eaebe 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java
@@ -35,18 +35,16 @@ import org.apache.ignite.plugin.extensions.communication.MessageCollectionItemTy
* Class for resolving {@link MessageWriter} "write*" methods for the corresponding message field type.
*/
class MessageWriterMethodResolver {
- /**
- *
- */
+ /** Method name resolver. */
private final BaseMethodNameResolver methodNameResolver;
- /**
- *
- */
+ /** Type converter. */
private final MessageCollectionItemTypeConverter typeConverter;
/**
- * @param processingEnvironment processing environment
+ * Constructor.
+ *
+ * @param processingEnvironment Processing environment.
*/
MessageWriterMethodResolver(ProcessingEnvironment processingEnvironment) {
methodNameResolver = new BaseMethodNameResolver(processingEnvironment);
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/RegistryInitializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/RegistryInitializerGenerator.java
index c840840..06bf4c5 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/RegistryInitializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/RegistryInitializerGenerator.java
@@ -37,17 +37,17 @@ import org.apache.ignite.network.serialization.MessageSerializationRegistry;
* <p>It is expected that only a single class will be generated for each module that declares any type of network messages.
*/
public class RegistryInitializerGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnv;
/** Message group. */
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnv processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnv Processing environment.
+ * @param messageGroup Message group.
*/
public RegistryInitializerGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/SerializationFactoryGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/SerializationFactoryGenerator.java
index d31407a..b3571c5 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/SerializationFactoryGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/SerializationFactoryGenerator.java
@@ -35,17 +35,17 @@ import org.apache.ignite.network.serialization.MessageSerializer;
* Class for generating {@link MessageSerializationFactory} classes.
*/
public class SerializationFactoryGenerator {
- /**
- *
- */
+ /** Processing environment. */
private final ProcessingEnvironment processingEnv;
/** Message group. */
private final MessageGroupWrapper messageGroup;
/**
- * @param processingEnv processing environment
- * @param messageGroup message group
+ * Constructor.
+ *
+ * @param processingEnv Processing environment.
+ * @param messageGroup Message group.
*/
public SerializationFactoryGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
diff --git a/modules/network-api/src/main/java/org/apache/ignite/network/MessagingService.java b/modules/network-api/src/main/java/org/apache/ignite/network/MessagingService.java
index 938667b..0b3621c 100644
--- a/modules/network-api/src/main/java/org/apache/ignite/network/MessagingService.java
+++ b/modules/network-api/src/main/java/org/apache/ignite/network/MessagingService.java
@@ -35,7 +35,9 @@ public interface MessagingService {
void weakSend(ClusterNode recipient, NetworkMessage msg);
/**
- * Tries to send the given message asynchronously to the specific cluster member with the following guarantees:
+ * Tries to send the given message asynchronously to the specific cluster member.
+ *
+ * <p>Guarantees:
* <ul>
* <li>Messages will be delivered in the same order as they were sent;</li>
* <li>If a message N has been successfully delivered to a member implies that all messages preceding N
diff --git a/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/netty/ItConnectionManagerTest.java b/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/netty/ItConnectionManagerTest.java
index a2c17f1..96ca3ff 100644
--- a/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/netty/ItConnectionManagerTest.java
+++ b/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/netty/ItConnectionManagerTest.java
@@ -73,7 +73,7 @@ public class ItConnectionManagerTest {
private NetworkConfiguration networkConfiguration;
/**
- *
+ * After each.
*/
@AfterEach
final void tearDown() {
diff --git a/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/recovery/ItRecoveryHandshakeTest.java b/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/recovery/ItRecoveryHandshakeTest.java
index d2b4180..a65c165 100644
--- a/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/recovery/ItRecoveryHandshakeTest.java
+++ b/modules/network/src/integrationTest/java/org/apache/ignite/internal/network/recovery/ItRecoveryHandshakeTest.java
@@ -72,7 +72,7 @@ public class ItRecoveryHandshakeTest {
private NetworkConfiguration networkConfiguration;
/**
- *
+ * After each.
*/
@AfterEach
final void tearDown() {
@@ -195,6 +195,8 @@ public class ItRecoveryHandshakeTest {
}
/**
+ * Returns generates handshake scenarios.
+ *
* @return Generates handshake scenarios.
*/
private static List<HandshakeScenario> handshakeScenarios() {
@@ -298,7 +300,7 @@ public class ItRecoveryHandshakeTest {
/** Fail on init. */
SERVER_INIT,
- /** Fail on connection open */
+ /** Fail on connection open. */
SERVER_CONNECTION_OPENED,
/** Fail on client response. */
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageReader.java b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageReader.java
index c428508..f4271a5 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageReader.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageReader.java
@@ -44,6 +44,8 @@ public class DirectMessageReader implements MessageReader {
private boolean lastRead;
/**
+ * Constructor.
+ *
* @param serializationRegistry Message serializers.
* @param protoVer Protocol version.
*/
@@ -416,7 +418,7 @@ public class DirectMessageReader implements MessageReader {
}
/**
- *
+ * State item.
*/
private static class StateItem implements DirectMessageStateItem {
/** Stream. */
@@ -426,6 +428,8 @@ public class DirectMessageReader implements MessageReader {
private int state;
/**
+ * Constructor.
+ *
* @param serializationRegistry Serialization registry.
* @param protoVer Protocol version.
*/
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageWriter.java b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageWriter.java
index 580e633..f084b11 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageWriter.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/DirectMessageWriter.java
@@ -33,11 +33,16 @@ import org.apache.ignite.network.serialization.MessageWriter;
import org.apache.ignite.plugin.extensions.communication.MessageCollectionItemType;
import org.jetbrains.annotations.Nullable;
+/**
+ * Message writer implementation.
+ */
public class DirectMessageWriter implements MessageWriter {
/** State. */
private final DirectMessageState<StateItem> state;
/**
+ * Constructor.
+ *
* @param serializationRegistry Serialization registry.
* @param protoVer Protocol version.
*/
@@ -383,17 +388,11 @@ public class DirectMessageWriter implements MessageWriter {
}
/**
- *
+ * State item.
*/
private static class StateItem implements DirectMessageStateItem {
- /**
- *
- */
private final DirectByteBufferStream stream;
-
- /**
- *
- */
+
private int state;
/**
@@ -407,6 +406,8 @@ public class DirectMessageWriter implements MessageWriter {
private boolean hdrWritten;
/**
+ * Constructor.
+ *
* @param registry Serialization registry.
* @param protoVer Protocol version.
*/
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/state/DirectMessageState.java b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/state/DirectMessageState.java
index 2737488..b3d6d95 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/state/DirectMessageState.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/state/DirectMessageState.java
@@ -37,6 +37,8 @@ public class DirectMessageState<T extends DirectMessageStateItem> {
private int pos;
/**
+ * Constructor.
+ *
* @param cls State item type.
* @param factory Item factory.
*/
@@ -49,6 +51,8 @@ public class DirectMessageState<T extends DirectMessageStateItem> {
}
/**
+ * Returns current item.
+ *
* @return Current item.
*/
public T item() {
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStream.java b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStream.java
index a228891..401e18b 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStream.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStream.java
@@ -33,156 +33,214 @@ import org.apache.ignite.plugin.extensions.communication.MessageCollectionItemTy
*/
public interface DirectByteBufferStream {
/**
+ * Sets buffer.
+ *
* @param buf Buffer.
*/
- public void setBuffer(ByteBuffer buf);
+ void setBuffer(ByteBuffer buf);
/**
+ * Returns number of remaining bytes.
+ *
* @return Number of remaining bytes.
*/
- public int remaining();
+ int remaining();
/**
+ * Returns whether last object was fully written or read.
+ *
* @return Whether last object was fully written or read.
*/
- public boolean lastFinished();
+ boolean lastFinished();
/**
+ * Writes {@code byte}.
+ *
* @param val Value.
*/
- public void writeByte(byte val);
+ void writeByte(byte val);
/**
+ * Writes {@code short}.
+ *
* @param val Value.
*/
- public void writeShort(short val);
+ void writeShort(short val);
/**
+ * Writes {@code int}.
+ *
* @param val Value.
*/
- public void writeInt(int val);
+ void writeInt(int val);
/**
+ * Writes {@code long}.
+ *
* @param val Value.
*/
- public void writeLong(long val);
+ void writeLong(long val);
/**
+ * Writes {@code float}.
+ *
* @param val Value.
*/
- public void writeFloat(float val);
+ void writeFloat(float val);
/**
+ * Writes {@code double}.
+ *
* @param val Value.
*/
- public void writeDouble(double val);
+ void writeDouble(double val);
/**
+ * Writes {@code char}.
+ *
* @param val Value.
*/
- public void writeChar(char val);
+ void writeChar(char val);
/**
+ * Writes {@code boolean}.
+ *
* @param val Value.
*/
- public void writeBoolean(boolean val);
+ void writeBoolean(boolean val);
/**
+ * Writes {@code byte} array.
+ *
* @param val Value.
*/
- public void writeByteArray(byte[] val);
+ void writeByteArray(byte[] val);
/**
+ * Writes {@code byte} array.
+ *
* @param val Value.
* @param off Offset.
* @param len Length.
*/
- public void writeByteArray(byte[] val, long off, int len);
+ void writeByteArray(byte[] val, long off, int len);
/**
+ * Writes {@code short} array.
+ *
* @param val Value.
*/
- public void writeShortArray(short[] val);
+ void writeShortArray(short[] val);
/**
+ * Writes {@code int} array.
+ *
* @param val Value.
*/
- public void writeIntArray(int[] val);
+ void writeIntArray(int[] val);
/**
+ * Writes {@code long} array.
+ *
* @param val Value.
*/
- public void writeLongArray(long[] val);
+ void writeLongArray(long[] val);
/**
+ * Writes {@code long} array.
+ *
* @param val Value.
* @param len Length.
*/
- public void writeLongArray(long[] val, int len);
+ void writeLongArray(long[] val, int len);
/**
+ * Writes {@code float} array.
+ *
* @param val Value.
*/
- public void writeFloatArray(float[] val);
+ void writeFloatArray(float[] val);
/**
+ * Writes {@code double} array.
+ *
* @param val Value.
*/
- public void writeDoubleArray(double[] val);
+ void writeDoubleArray(double[] val);
/**
+ * Writes {@code char} array.
+ *
* @param val Value.
*/
- public void writeCharArray(char[] val);
+ void writeCharArray(char[] val);
/**
+ * Writes {@code boolean} array.
+ *
* @param val Value.
*/
- public void writeBooleanArray(boolean[] val);
+ void writeBooleanArray(boolean[] val);
/**
+ * Writes {@link String}.
+ *
* @param val Value.
*/
- public void writeString(String val);
+ void writeString(String val);
/**
+ * Writes {@link BitSet}.
+ *
* @param val Value.
*/
- public void writeBitSet(BitSet val);
+ void writeBitSet(BitSet val);
/**
+ * Writes {@link UUID}.
+ *
* @param val Value.
*/
- public void writeUuid(UUID val);
+ void writeUuid(UUID val);
/**
+ * Writes {@link IgniteUuid}.
+ *
* @param val Value.
*/
- public void writeIgniteUuid(IgniteUuid val);
+ void writeIgniteUuid(IgniteUuid val);
/**
+ * Writes {@link NetworkMessage}.
+ *
* @param msg Message.
* @param writer Writer.
*/
- public void writeMessage(NetworkMessage msg, MessageWriter writer);
+ void writeMessage(NetworkMessage msg, MessageWriter writer);
/**
+ * Writes {@link Object} array.
+ *
* @param <T> Type of the array.
* @param arr Array.
* @param itemType Component type.
* @param writer Writer.
*/
- public <T> void writeObjectArray(T[] arr, MessageCollectionItemType itemType, MessageWriter writer);
+ <T> void writeObjectArray(T[] arr, MessageCollectionItemType itemType, MessageWriter writer);
/**
+ * Writes {@link Collection}.
+ *
* @param <T> Type of the collection.
* @param col Collection.
* @param itemType Component type.
* @param writer Writer.
*/
- public <T> void writeCollection(Collection<T> col, MessageCollectionItemType itemType, MessageWriter writer);
+ <T> void writeCollection(Collection<T> col, MessageCollectionItemType itemType, MessageWriter writer);
/**
+ * Writes {@link Map}.
+ *
* @param <K> Type of the map's keys.
* @param <V> Type of the map's values.
* @param map Map.
@@ -190,141 +248,189 @@ public interface DirectByteBufferStream {
* @param valType Value type.
* @param writer Writer.
*/
- public <K, V> void writeMap(Map<K, V> map, MessageCollectionItemType keyType, MessageCollectionItemType valType,
+ <K, V> void writeMap(Map<K, V> map, MessageCollectionItemType keyType, MessageCollectionItemType valType,
MessageWriter writer);
/**
+ * Reads {@code byte}.
+ *
* @return Value.
*/
- public byte readByte();
+ byte readByte();
/**
+ * Reads {@code short}.
+ *
* @return Value.
*/
- public short readShort();
+ short readShort();
/**
+ * Reads {@code int}.
+ *
* @return Value.
*/
- public int readInt();
+ int readInt();
/**
+ * Reads {@code long}.
+ *
* @return Value.
*/
- public long readLong();
+ long readLong();
/**
+ * Reads {@code float}.
+ *
* @return Value.
*/
- public float readFloat();
+ float readFloat();
/**
+ * Reads {@code double}.
+ *
* @return Value.
*/
- public double readDouble();
+ double readDouble();
/**
+ * Reads {@code char}.
+ *
* @return Value.
*/
- public char readChar();
+ char readChar();
/**
+ * Reads {@code boolean}.
+ *
* @return Value.
*/
- public boolean readBoolean();
+ boolean readBoolean();
/**
+ * Reads {@code byte} array.
+ *
* @return Value.
*/
- public byte[] readByteArray();
+ byte[] readByteArray();
/**
+ * Reads {@code short} array.
+ *
* @return Value.
*/
- public short[] readShortArray();
+ short[] readShortArray();
/**
+ * Reads {@code int} array.
+ *
* @return Value.
*/
- public int[] readIntArray();
+ int[] readIntArray();
/**
+ * Reads {@code long} array.
+ *
* @return Value.
*/
- public long[] readLongArray();
+ long[] readLongArray();
/**
+ * Reads {@code float} array.
+ *
* @return Value.
*/
- public float[] readFloatArray();
+ float[] readFloatArray();
/**
+ * Reads {@code double} array.
+ *
* @return Value.
*/
- public double[] readDoubleArray();
+ double[] readDoubleArray();
/**
+ * Reads {@code char} array.
+ *
* @return Value.
*/
- public char[] readCharArray();
+ char[] readCharArray();
/**
+ * Reads {@code boolean} array.
+ *
* @return Value.
*/
- public boolean[] readBooleanArray();
+ boolean[] readBooleanArray();
/**
+ * Reads {@link String}.
+ *
* @return Value.
*/
- public String readString();
+ String readString();
/**
+ * Reads {@link BitSet}.
+ *
* @return Value.
*/
- public BitSet readBitSet();
+ BitSet readBitSet();
/**
+ * Reads {@link UUID}.
+ *
* @return Value.
*/
- public UUID readUuid();
+ UUID readUuid();
/**
+ * Reads {@link IgniteUuid}.
+ *
* @return Value.
*/
- public IgniteUuid readIgniteUuid();
+ IgniteUuid readIgniteUuid();
/**
- * @param <T> Type of a message.
+ * Reads {@link NetworkMessage}.
+ *
+ * @param <T> Type of message.
* @param reader Reader.
* @return Message.
*/
- public <T extends NetworkMessage> T readMessage(MessageReader reader);
+ <T extends NetworkMessage> T readMessage(MessageReader reader);
/**
- * @param <T> Type of an array.
+ * Reads {@link Object} array.
+ *
+ * @param <T> Type of array.
* @param itemType Item type.
* @param itemCls Item class.
* @param reader Reader.
* @return Array.
*/
- public <T> T[] readObjectArray(MessageCollectionItemType itemType, Class<T> itemCls, MessageReader reader);
+ <T> T[] readObjectArray(MessageCollectionItemType itemType, Class<T> itemCls, MessageReader reader);
/**
- * @param <C> Type of a collection.
+ * Reads {@link Collection}.
+ *
+ * @param <C> Type of collection.
* @param itemType Item type.
* @param reader Reader.
* @return Collection.
*/
- public <C extends Collection<?>> C readCollection(MessageCollectionItemType itemType, MessageReader reader);
+ <C extends Collection<?>> C readCollection(MessageCollectionItemType itemType, MessageReader reader);
/**
- * @param <M> Type of a map.
+ * Reads {@link Map}.
+ *
+ * @param <M> Type of map.
* @param keyType Key type.
* @param valType Value type.
* @param linked Whether linked map should be created.
* @param reader Reader.
* @return Map.
*/
- public <M extends Map<?, ?>> M readMap(MessageCollectionItemType keyType, MessageCollectionItemType valType,
+ <M extends Map<?, ?>> M readMap(MessageCollectionItemType keyType, MessageCollectionItemType valType,
boolean linked, MessageReader reader);
}
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStreamImplV1.java b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStreamImplV1.java
index 5b8f0e8..f42de5c 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStreamImplV1.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/direct/stream/DirectByteBufferStreamImplV1.java
@@ -57,51 +57,30 @@ import org.apache.ignite.network.serialization.MessageWriter;
import org.apache.ignite.plugin.extensions.communication.MessageCollectionItemType;
import org.jetbrains.annotations.Nullable;
+/**
+ * {@link DirectByteBufferStream} implementation.
+ */
public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
/** Poison object. */
private static final Object NULL = new Object();
-
- /**
- *
- */
+
private final MessageSerializationRegistry serializationRegistry;
-
- /**
- *
- */
+
private ByteBuffer buf;
-
- /**
- *
- */
+
private byte[] heapArr;
-
- /**
- *
- */
+
private long baseOff;
-
- /**
- *
- */
+
private int arrOff = -1;
-
- /**
- *
- */
+
private Object tmpArr;
-
- /**
- *
- */
+
private int tmpArrOff;
/** Number of bytes of the boundary value, read from previous message. */
private int valReadBytes;
-
- /**
- *
- */
+
private int tmpArrBytes;
/**
@@ -117,112 +96,54 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
* message type.
*/
private short msgGroupType;
-
- /**
- *
- */
+
@Nullable
private MessageDeserializer<NetworkMessage> msgDeserializer;
-
- /**
- *
- */
+
private Iterator<?> mapIt;
-
- /**
- *
- */
+
private Iterator<?> it;
-
- /**
- *
- */
+
private int arrPos = -1;
-
- /**
- *
- */
+
private Object arrCur = NULL;
-
- /**
- *
- */
+
private Object mapCur = NULL;
-
- /**
- *
- */
+
private Object cur = NULL;
-
- /**
- *
- */
+
private boolean keyDone;
-
- /**
- *
- */
+
private int readSize = -1;
-
- /**
- *
- */
+
private int readItems;
-
- /**
- *
- */
+
private Object[] objArr;
-
- /**
- *
- */
+
private Collection<Object> col;
-
- /**
- *
- */
+
private Map<Object, Object> map;
-
- /**
- *
- */
+
private long prim;
-
- /**
- *
- */
+
private int primShift;
-
- /**
- *
- */
+
private int uuidState;
-
- /**
- *
- */
+
private long uuidMost;
-
- /**
- *
- */
+
private long uuidLeast;
-
- /**
- *
- */
+
private long uuidLocId;
-
- /**
- *
- */
+
protected boolean lastFinished;
- /** byte-array representation of string */
+ /** byte-array representation of string. */
private byte[] curStrBackingArr;
/**
+ * Constructor.
+ *
* @param serializationRegistry Message mappers.
*/
public DirectByteBufferStreamImplV1(MessageSerializationRegistry serializationRegistry) {
@@ -762,6 +683,8 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
+ * Writes {@link List}.
+ *
* @param list List.
* @param itemType Component type.
* @param writer Writer.
@@ -1421,6 +1344,8 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
+ * Writes array.
+ *
* @param arr Array.
* @param off Offset.
* @param len Length.
@@ -1467,6 +1392,8 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
+ * Writes array.
+ *
* @param arr Array.
* @param off Offset.
* @param len Length.
@@ -1507,6 +1434,8 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
+ * Writes array.
+ *
* @param arr Array.
* @param off Offset.
* @param len Length.
@@ -1528,6 +1457,8 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
+ * Writes array length.
+ *
* @param len Length.
*/
private boolean writeArrayLength(int len) {
@@ -1544,7 +1475,9 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
- * @param <T> Type of an array.
+ * Reads array.
+ *
+ * @param <T> Type of array.
* @param creator Array creator.
* @param lenShift Array length shift size.
* @param off Base offset.
@@ -1607,7 +1540,9 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
- * @param <T> Type of an array.
+ * Reads array.
+ *
+ * @param <T> Type of array.
* @param creator Array creator.
* @param typeSize Primitive type size in bytes.
* @param lenShift Array length shift size.
@@ -1678,6 +1613,13 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
}
+ /**
+ * Writes value.
+ *
+ * @param type Type.
+ * @param val Value.
+ * @param writer Writer.
+ */
protected void write(MessageCollectionItemType type, Object val, MessageWriter writer) {
switch (type) {
case BYTE:
@@ -1801,6 +1743,8 @@ public class DirectByteBufferStreamImplV1 implements DirectByteBufferStream {
}
/**
+ * Reads value.
+ *
* @param type Type.
* @param reader Reader.
* @return Value.
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeManager.java b/modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeManager.java
index c78fff2..39e96cc 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeManager.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/handshake/HandshakeManager.java
@@ -53,6 +53,8 @@ public interface HandshakeManager {
HandshakeAction onMessage(Channel channel, NetworkMessage message);
/**
+ * Returns future that represents the handshake operation.
+ *
* @return Future that represents the handshake operation.
*/
CompletableFuture<NettySender> handshakeFuture();
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/ConnectionManager.java b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/ConnectionManager.java
index e2a2907..7a08a8f 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/ConnectionManager.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/ConnectionManager.java
@@ -153,6 +153,8 @@ public class ConnectionManager {
}
/**
+ * Returns server local address.
+ *
* @return Server local address.
*/
public SocketAddress getLocalAddress() {
@@ -275,6 +277,8 @@ public class ConnectionManager {
}
/**
+ * Returns connection manager's {@link #server}.
+ *
* @return Connection manager's {@link #server}.
*/
@TestOnly
@@ -283,6 +287,8 @@ public class ConnectionManager {
}
/**
+ * Returns this node's consistent id.
+ *
* @return This node's consistent id.
*/
@TestOnly
@@ -291,6 +297,8 @@ public class ConnectionManager {
}
/**
+ * Returns collection of all the clients started by this connection manager.
+ *
* @return Collection of all the clients started by this connection manager.
*/
@TestOnly
@@ -300,6 +308,8 @@ public class ConnectionManager {
/**
+ * Returns map of the channels.
+ *
* @return Map of the channels.
*/
@TestOnly
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyClient.java b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyClient.java
index a40b7f7..2c4d28a 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyClient.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyClient.java
@@ -146,6 +146,8 @@ public class NettyClient {
}
/**
+ * Returns client start future.
+ *
* @return Client start future.
*/
@Nullable
@@ -179,6 +181,8 @@ public class NettyClient {
}
/**
+ * Returns {@code true} if the client has failed to connect to the remote server, {@code false} otherwise.
+ *
* @return {@code true} if the client has failed to connect to the remote server, {@code false} otherwise.
*/
public boolean failedToConnect() {
@@ -186,6 +190,8 @@ public class NettyClient {
}
/**
+ * Returns {@code true} if the client has lost the connection or has been stopped, {@code false} otherwise.
+ *
* @return {@code true} if the client has lost the connection or has been stopped, {@code false} otherwise.
*/
public boolean isDisconnected() {
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettySender.java b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettySender.java
index 5e7bf08..6185994 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettySender.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettySender.java
@@ -61,6 +61,8 @@ public class NettySender {
}
/**
+ * Returns launch id of the remote node.
+ *
* @return Launch id of the remote node.
*/
public String launchId() {
@@ -68,6 +70,8 @@ public class NettySender {
}
/**
+ * Returns consistent id of the remote node.
+ *
* @return Consistent id of the remote node.
*/
public String consistentId() {
@@ -82,6 +86,8 @@ public class NettySender {
}
/**
+ * Returns {@code true} if the channel is open, {@code false} otherwise.
+ *
* @return {@code true} if the channel is open, {@code false} otherwise.
*/
public boolean isOpen() {
@@ -89,6 +95,8 @@ public class NettySender {
}
/**
+ * Returns channel.
+ *
* @return Channel.
*/
@TestOnly
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyServer.java b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyServer.java
index 869b297..2bba177 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyServer.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/netty/NettyServer.java
@@ -301,6 +301,8 @@ public class NettyServer {
}
/**
+ * Returns gets the local address of the server.
+ *
* @return Gets the local address of the server.
*/
public SocketAddress address() {
@@ -344,6 +346,8 @@ public class NettyServer {
}
/**
+ * Returns {@code true} if the server is running, {@code false} otherwise.
+ *
* @return {@code true} if the server is running, {@code false} otherwise.
*/
@TestOnly
@@ -352,7 +356,9 @@ public class NettyServer {
}
/**
- * @return Accepter event loop group.
+ * Returns acceptor event loop group.
+ *
+ * @return Acceptor event loop group.
*/
@TestOnly
public NioEventLoopGroup getBossGroup() {
@@ -360,6 +366,8 @@ public class NettyServer {
}
/**
+ * Returns worker event loop group.
+ *
* @return Worker event loop group.
*/
@TestOnly
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryClientHandshakeManager.java b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryClientHandshakeManager.java
index 2264a2a..8081aeb 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryClientHandshakeManager.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryClientHandshakeManager.java
@@ -48,9 +48,11 @@ public class RecoveryClientHandshakeManager implements HandshakeManager {
private final NetworkMessagesFactory messageFactory;
/**
- * @param launchId launch id
- * @param consistentId consistent id
- * @param messageFactory message factory
+ * Constructor.
+ *
+ * @param launchId Launch id.
+ * @param consistentId Consistent id.
+ * @param messageFactory Message factory.
*/
public RecoveryClientHandshakeManager(
UUID launchId, String consistentId, NetworkMessagesFactory messageFactory
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryServerHandshakeManager.java b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryServerHandshakeManager.java
index 27b1693..f7442a6 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryServerHandshakeManager.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/RecoveryServerHandshakeManager.java
@@ -48,9 +48,11 @@ public class RecoveryServerHandshakeManager implements HandshakeManager {
private final NetworkMessagesFactory messageFactory;
/**
- * @param launchId launch id
- * @param consistentId consistent id
- * @param messageFactory message factory
+ * Constructor.
+ *
+ * @param launchId Launch id.
+ * @param consistentId Consistent id.
+ * @param messageFactory Message factory.
*/
public RecoveryServerHandshakeManager(
UUID launchId, String consistentId, NetworkMessagesFactory messageFactory
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartMessage.java b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartMessage.java
index 1d0cc52..fc429d7 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartMessage.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartMessage.java
@@ -28,12 +28,16 @@ import org.apache.ignite.network.annotations.Transferable;
@Transferable(NetworkMessageTypes.HANDSHAKE_START)
public interface HandshakeStartMessage extends NetworkMessage {
/**
- * @return launch id
+ * Returns launch id.
+ *
+ * @return Launch id.
*/
UUID launchId();
/**
- * @return consistent id
+ * Returns consistent id.
+ *
+ * @return Consistent id.
*/
String consistentId();
}
diff --git a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartResponseMessage.java b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartResponseMessage.java
index b2a30d0..77e5207 100644
--- a/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartResponseMessage.java
+++ b/modules/network/src/main/java/org/apache/ignite/internal/network/recovery/message/HandshakeStartResponseMessage.java
@@ -28,22 +28,30 @@ import org.apache.ignite.network.annotations.Transferable;
@Transferable(NetworkMessageTypes.HANDSHAKE_START_RESPONSE)
public interface HandshakeStartResponseMessage extends NetworkMessage {
/**
- * @return launch id
+ * Returns launch id.
+ *
+ * @return Launch id.
*/
UUID launchId();
/**
- * @return consistent id
+ * Returns consistent id.
+ *
+ * @return Consistent id.
*/
String consistentId();
/**
- * @return number of received messages
+ * Returns number of received messages.
+ *
+ * @return Number of received messages.
*/
long receivedCount();
/**
- * @return connections count
+ * Returns connections count.
+ *
+ * @return Connections count.
*/
long connectionsCount();
}
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/AllTypesMessage.java b/modules/network/src/test/java/org/apache/ignite/internal/network/AllTypesMessage.java
index bae21b6..a8d0504 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/AllTypesMessage.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/AllTypesMessage.java
@@ -26,6 +26,9 @@ import org.apache.ignite.network.NetworkMessage;
import org.apache.ignite.network.TestMessageTypes;
import org.apache.ignite.network.annotations.Transferable;
+/**
+ * {@link NetworkMessage} implementation.
+ */
@Transferable(TestMessageTypes.ALL_TYPES)
public interface AllTypesMessage extends NetworkMessage {
byte byteA();
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/NestedMessageMessage.java b/modules/network/src/test/java/org/apache/ignite/internal/network/NestedMessageMessage.java
index 1985dd9..517ee61 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/NestedMessageMessage.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/NestedMessageMessage.java
@@ -21,6 +21,9 @@ import org.apache.ignite.network.NetworkMessage;
import org.apache.ignite.network.TestMessageTypes;
import org.apache.ignite.network.annotations.Transferable;
+/**
+ * Nested {@link NetworkMessage} implementation.
+ */
@Transferable(TestMessageTypes.NESTED_MESSAGE)
public interface NestedMessageMessage extends NetworkMessage {
NetworkMessage nestedMessage();
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/netty/IoExceptionSuppressingHandlerTest.java b/modules/network/src/test/java/org/apache/ignite/internal/network/netty/IoExceptionSuppressingHandlerTest.java
index 17ca2fc..7e3ce17 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/netty/IoExceptionSuppressingHandlerTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/netty/IoExceptionSuppressingHandlerTest.java
@@ -30,14 +30,8 @@ import org.junit.jupiter.api.Test;
* Test class for the {@link IoExceptionSuppressingHandler}.
*/
public class IoExceptionSuppressingHandlerTest {
- /**
- *
- */
private final ChannelHandlerContext context = mock(ChannelHandlerContext.class);
-
- /**
- *
- */
+
private final IoExceptionSuppressingHandler handler = new IoExceptionSuppressingHandler();
/**
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyClientTest.java b/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyClientTest.java
index 0031a45..8d03e30 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyClientTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyClientTest.java
@@ -47,14 +47,11 @@ import org.mockito.Mockito;
public class NettyClientTest {
/** Client. */
private NettyClient client;
-
- /**
- *
- */
+
private final SocketAddress address = InetSocketAddress.createUnresolved("", 0);
/**
- *
+ * After each.
*/
@AfterEach
void tearDown() {
@@ -221,14 +218,8 @@ public class NettyClientTest {
* Tuple for a NettyClient and a future of a NettySender.
*/
private static class ClientAndSender {
- /**
- *
- */
private final NettyClient client;
-
- /**
- *
- */
+
private final CompletableFuture<NettySender> sender;
/**
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyServerTest.java b/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyServerTest.java
index 312c162..1c905e4 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyServerTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/netty/NettyServerTest.java
@@ -71,7 +71,7 @@ public class NettyServerTest {
private NetworkConfiguration serverCfg;
/**
- *
+ * After each.
*/
@AfterEach
final void tearDown() {
@@ -262,7 +262,9 @@ public class NettyServerTest {
}
/**
- * @return Verification mode for a one call with a 3 second timeout.
+ * Returns verification mode for a one call with a 3-second timeout.
+ *
+ * @return Verification mode for a one call with a 3-second timeout.
*/
private static VerificationMode timeout() {
return Mockito.timeout(TimeUnit.SECONDS.toMillis(3));
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessage.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessage.java
index 1e185db..e7ea00f 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessage.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessage.java
@@ -22,7 +22,7 @@ import org.apache.ignite.network.TestMessageTypes;
import org.apache.ignite.network.annotations.Transferable;
/**
- *
+ * Empty {@link NetworkMessage} implementation.
*/
@Transferable(TestMessageTypes.EMPTY_MESSAGE)
public interface EmptyMessage extends NetworkMessage {
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessageTest.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessageTest.java
index 244fae2..c192b1f 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessageTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/EmptyMessageTest.java
@@ -24,12 +24,9 @@ import org.apache.ignite.network.TestMessagesFactory;
import org.junit.jupiter.api.Test;
/**
- *
+ * Test class for {@link EmptyMessage}.
*/
public class EmptyMessageTest {
- /**
- *
- */
private final TestMessagesFactory factory = new TestMessagesFactory();
/**
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessage.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessage.java
index 0400a8f..681b303 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessage.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessage.java
@@ -17,16 +17,14 @@
package org.apache.ignite.internal.network.processor;
+import org.apache.ignite.network.NetworkMessage;
import org.apache.ignite.network.TestMessageTypes;
import org.apache.ignite.network.annotations.Transferable;
/**
- *
+ * {@link NetworkMessage} implementation.
*/
@Transferable(TestMessageTypes.INHERITED_MESSAGE)
public interface InheritedMessage extends NetworkMessage2 {
- /**
- *
- */
int intZ();
}
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessageTest.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessageTest.java
index 10c765f..e838d34 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessageTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/InheritedMessageTest.java
@@ -38,14 +38,8 @@ import org.mockito.InOrder;
* @see InheritedMessage
*/
public class InheritedMessageTest {
- /**
- *
- */
private final TestMessagesFactory messageFactory = new TestMessagesFactory();
-
- /**
- *
- */
+
private final InheritedMessageSerializationFactory serializationFactory =
new InheritedMessageSerializationFactory(messageFactory);
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage1.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage1.java
index 721a9c8..209bad2 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage1.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage1.java
@@ -21,11 +21,8 @@ package org.apache.ignite.internal.network.processor;
import org.apache.ignite.network.NetworkMessage;
/**
- *
+ * {@link NetworkMessage} implementation.
*/
interface NetworkMessage1 extends NetworkMessage {
- /**
- *
- */
int intY();
}
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage2.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage2.java
index c6bf53d..50879a1 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage2.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/NetworkMessage2.java
@@ -19,13 +19,11 @@
package org.apache.ignite.internal.network.processor;
import java.io.Serializable;
+import org.apache.ignite.network.NetworkMessage;
/**
- *
+ * {@link NetworkMessage} implementation.
*/
interface NetworkMessage2 extends NetworkMessage1, Serializable {
- /**
- *
- */
int intX();
}
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderMessage.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderMessage.java
index 8a4847d..a6f3acd 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderMessage.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderMessage.java
@@ -26,23 +26,11 @@ import org.apache.ignite.network.annotations.Transferable;
*/
@Transferable(TestMessageTypes.SERIALIZATION_ORDER_MESSAGE)
public interface SerializationOrderMessage extends NetworkMessage {
- /**
- *
- */
String strB();
-
- /**
- *
- */
+
String strD();
-
- /**
- *
- */
+
int intC();
-
- /**
- *
- */
+
int intA();
}
diff --git a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderTest.java b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderTest.java
index 315af7c..1d7bbf8 100644
--- a/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/internal/network/processor/SerializationOrderTest.java
@@ -36,14 +36,8 @@ import org.mockito.InOrder;
* Test class for checking that writing and reading fields in the generated (de-)serializers is ordered alphanumerically.
*/
public class SerializationOrderTest {
- /**
- *
- */
private final TestMessagesFactory messageFactory = new TestMessagesFactory();
-
- /**
- *
- */
+
private final SerializationOrderMessageSerializationFactory serializationFactory =
new SerializationOrderMessageSerializationFactory(messageFactory);
diff --git a/modules/network/src/test/java/org/apache/ignite/network/MessageSerializationRegistryImplTest.java b/modules/network/src/test/java/org/apache/ignite/network/MessageSerializationRegistryImplTest.java
index f7baa0f..c51bbbb 100644
--- a/modules/network/src/test/java/org/apache/ignite/network/MessageSerializationRegistryImplTest.java
+++ b/modules/network/src/test/java/org/apache/ignite/network/MessageSerializationRegistryImplTest.java
@@ -106,19 +106,13 @@ public class MessageSerializationRegistryImplTest {
assertNotNull(registry.createSerializer(Short.MAX_VALUE, Short.MAX_VALUE));
}
-
+
/**
- *
+ * {@link NetworkMessage} implementation.
*/
private static class Msg implements NetworkMessage {
- /**
- *
- */
static final short GROUP_TYPE = 0;
-
- /**
- *
- */
+
static final short TYPE = 0;
/** {@inheritDoc} */
@@ -133,9 +127,9 @@ public class MessageSerializationRegistryImplTest {
return GROUP_TYPE;
}
}
-
+
/**
- *
+ * {@link MessageSerializationFactory} implementation.
*/
private static class MsgSerializationFactory implements MessageSerializationFactory<Msg> {
/** {@inheritDoc} */
diff --git a/modules/network/src/test/java/org/apache/ignite/network/TestMessage.java b/modules/network/src/test/java/org/apache/ignite/network/TestMessage.java
index 5928a63..ae27afa 100644
--- a/modules/network/src/test/java/org/apache/ignite/network/TestMessage.java
+++ b/modules/network/src/test/java/org/apache/ignite/network/TestMessage.java
@@ -21,6 +21,9 @@ import java.io.Serializable;
import java.util.Map;
import org.apache.ignite.network.annotations.Transferable;
+/**
+ * {@link NetworkMessage} implementation.
+ */
@Transferable(TestMessageTypes.TEST)
public interface TestMessage extends NetworkMessage, Serializable {
String msg();
diff --git a/modules/network/src/test/java/org/apache/ignite/network/TestMessageTypes.java b/modules/network/src/test/java/org/apache/ignite/network/TestMessageTypes.java
index bf2d4d5..9309a26 100644
--- a/modules/network/src/test/java/org/apache/ignite/network/TestMessageTypes.java
+++ b/modules/network/src/test/java/org/apache/ignite/network/TestMessageTypes.java
@@ -22,29 +22,23 @@ import org.apache.ignite.internal.network.processor.InheritedMessage;
import org.apache.ignite.internal.network.processor.SerializationOrderMessage;
import org.apache.ignite.network.annotations.MessageGroup;
+/**
+ * Test message types.
+ */
@MessageGroup(groupName = "TestMessages", groupType = 2)
public class TestMessageTypes {
- /** Type of {@link SerializationOrderMessage} */
+ /** Type of {@link SerializationOrderMessage}. */
public static final short SERIALIZATION_ORDER_MESSAGE = 1;
- /** Type of {@link InheritedMessage} */
+ /** Type of {@link InheritedMessage}. */
public static final short INHERITED_MESSAGE = 2;
- /** Type of {@link EmptyMessage} */
+ /** Type of {@link EmptyMessage}. */
public static final short EMPTY_MESSAGE = 3;
-
- /**
- *
- */
+
public static final short ALL_TYPES = 4;
-
- /**
- *
- */
+
public static final short TEST = 5;
-
- /**
- *
- */
+
public static final short NESTED_MESSAGE = 6;
}
diff --git a/modules/rocksdb-common/src/main/java/org/apache/ignite/internal/rocksdb/ColumnFamily.java b/modules/rocksdb-common/src/main/java/org/apache/ignite/internal/rocksdb/ColumnFamily.java
index 1549a6a..7c8b91a 100644
--- a/modules/rocksdb-common/src/main/java/org/apache/ignite/internal/rocksdb/ColumnFamily.java
+++ b/modules/rocksdb-common/src/main/java/org/apache/ignite/internal/rocksdb/ColumnFamily.java
@@ -174,6 +174,8 @@ public class ColumnFamily implements AutoCloseable {
}
/**
+ * Returns column family handle.
+ *
* @return Column family handle.
*/
public ColumnFamilyHandle handle() {
@@ -181,6 +183,8 @@ public class ColumnFamily implements AutoCloseable {
}
/**
+ * Returns name of the column family.
+ *
* @return Name of the column family.
*/
public String name() {
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/DataRow.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/DataRow.java
index 684df5c..f63eedc 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/DataRow.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/DataRow.java
@@ -24,11 +24,15 @@ import java.nio.ByteBuffer;
*/
public interface DataRow extends SearchRow {
/**
+ * Returns value bytes.
+ *
* @return Value bytes.
*/
byte[] valueBytes();
/**
+ * Returns value object as a byte buffer. Allows more effective memory management in certain cases.
+ *
* @return Value object as a byte buffer. Allows more effective memory management in certain cases.
*/
ByteBuffer value();
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/InvokeClosure.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/InvokeClosure.java
index ec1cb8a..903d4ae 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/InvokeClosure.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/InvokeClosure.java
@@ -34,6 +34,8 @@ public interface InvokeClosure<T> {
void call(@Nullable DataRow row);
/**
+ * Returns result of the invocation. Can be {@code null}.
+ *
* @return Result of the invocation. Can be {@code null}.
*/
@Nullable
@@ -42,11 +44,16 @@ public interface InvokeClosure<T> {
}
/**
+ * Returns new row for the {@link OperationType#WRITE} operation.
+ *
* @return New row for the {@link OperationType#WRITE} operation.
*/
@Nullable DataRow newRow();
/**
+ * Returns operation type for this closure or {@code null} if it is unknown. After method {@link #call(DataRow)} has been called,
+ * operation type must be computed and this method cannot return {@code null}.
+ *
* @return Operation type for this closure or {@code null} if it is unknown. After method {@link #call(DataRow)} has been called,
* operation type must be computed and this method cannot return {@code null}.
*/
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/SearchRow.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/SearchRow.java
index ce3ceff..81ec3e1 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/SearchRow.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/SearchRow.java
@@ -25,11 +25,15 @@ import org.jetbrains.annotations.NotNull;
*/
public interface SearchRow {
/**
+ * Returns key bytes.
+ *
* @return Key bytes.
*/
byte @NotNull [] keyBytes();
/**
+ * Returns key object as a byte buffer. Allows more effective memory management in certain cases.
+ *
* @return Key object as a byte buffer. Allows more effective memory management in certain cases.
*/
@NotNull ByteBuffer key();
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/StorageException.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/StorageException.java
index e49505e..ab13411 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/StorageException.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/StorageException.java
@@ -22,6 +22,8 @@ package org.apache.ignite.internal.storage;
*/
public class StorageException extends RuntimeException {
/**
+ * Constructor.
+ *
* @param message Error message.
*/
public StorageException(String message) {
@@ -29,6 +31,8 @@ public class StorageException extends RuntimeException {
}
/**
+ * Constructor.
+ *
* @param message Error message.
* @param cause The cause.
*/
@@ -37,6 +41,8 @@ public class StorageException extends RuntimeException {
}
/**
+ * Constructor.
+ *
* @param cause The cause.
*/
public StorageException(Throwable cause) {
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndRemoveInvokeClosure.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndRemoveInvokeClosure.java
index 2c3f545..641d824 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndRemoveInvokeClosure.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndRemoveInvokeClosure.java
@@ -50,6 +50,8 @@ public class GetAndRemoveInvokeClosure implements InvokeClosure<Boolean> {
}
/**
+ * Returns row that is removed.
+ *
* @return Row that is removed.
*/
@Nullable
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndReplaceInvokeClosure.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndReplaceInvokeClosure.java
index e3a90a6..7311471 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndReplaceInvokeClosure.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/GetAndReplaceInvokeClosure.java
@@ -73,6 +73,8 @@ public class GetAndReplaceInvokeClosure implements InvokeClosure<Boolean> {
}
/**
+ * Returns previous data row.
+ *
* @return Previous data row.
*/
@Nullable
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleDataRow.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleDataRow.java
index 98f636a..35aa8fd 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleDataRow.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleDataRow.java
@@ -33,6 +33,8 @@ public class SimpleDataRow implements DataRow {
private final byte[] value;
/**
+ * Constructor.
+ *
* @param key Key.
* @param value Value.
*/
diff --git a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleWriteInvokeClosure.java b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleWriteInvokeClosure.java
index 02b628c..8260fc7 100644
--- a/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleWriteInvokeClosure.java
+++ b/modules/storage-api/src/main/java/org/apache/ignite/internal/storage/basic/SimpleWriteInvokeClosure.java
@@ -28,6 +28,8 @@ public class SimpleWriteInvokeClosure implements InvokeClosure<Void> {
private final DataRow newRow;
/**
+ * Constructor.
+ *
* @param newRow Data row to write into the storage.
*/
public SimpleWriteInvokeClosure(DataRow newRow) {
diff --git a/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbDataRegion.java b/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbDataRegion.java
index ec96b0b..b6a1dc3 100644
--- a/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbDataRegion.java
+++ b/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbDataRegion.java
@@ -89,6 +89,8 @@ public class RocksDbDataRegion implements DataRegion {
}
/**
+ * Returns write buffer manager associated withthe region.
+ *
* @return Write buffer manager associated withthe region.
*/
public WriteBufferManager writeBufferManager() {
diff --git a/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbPartitionStorage.java b/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbPartitionStorage.java
index 0668e21..642b296 100644
--- a/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbPartitionStorage.java
+++ b/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbPartitionStorage.java
@@ -60,7 +60,7 @@ import org.rocksdb.WriteOptions;
* Storage implementation based on a single RocksDB instance.
*/
public class RocksDbPartitionStorage implements PartitionStorage {
- /** Suffix for the temporary snapshot folder */
+ /** Suffix for the temporary snapshot folder. */
private static final String TMP_SUFFIX = ".tmp";
/** Partition id. */
@@ -403,6 +403,8 @@ public class RocksDbPartitionStorage implements PartitionStorage {
private final Predicate<SearchRow> filter;
/**
+ * Constructor.
+ *
* @param iter Iterator.
* @param filter Filter.
*/
diff --git a/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbTableStorage.java b/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbTableStorage.java
index 754925c..98cdf2d 100644
--- a/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbTableStorage.java
+++ b/modules/storage-rocksdb/src/main/java/org/apache/ignite/internal/storage/rocksdb/RocksDbTableStorage.java
@@ -101,10 +101,7 @@ public class RocksDbTableStorage implements TableStorage {
/** Column families for indexes by their names. */
private final Map<String, ColumnFamilyHandle> indicesCfHandles = new ConcurrentHashMap<>();
-
- /**
- *
- */
+
private boolean stopped = false;
/** Utility enum to describe a type of the column family - meta, partition or index. */
diff --git a/modules/storage-rocksdb/src/test/java/org/apache/ignite/internal/storage/rocksdb/RocksDbStorageTest.java b/modules/storage-rocksdb/src/test/java/org/apache/ignite/internal/storage/rocksdb/RocksDbStorageTest.java
index a34f2cd..375ae5c 100644
--- a/modules/storage-rocksdb/src/test/java/org/apache/ignite/internal/storage/rocksdb/RocksDbStorageTest.java
+++ b/modules/storage-rocksdb/src/test/java/org/apache/ignite/internal/storage/rocksdb/RocksDbStorageTest.java
@@ -42,18 +42,12 @@ import org.junit.jupiter.api.extension.ExtendWith;
@ExtendWith(WorkDirectoryExtension.class)
@ExtendWith(ConfigurationExtension.class)
public class RocksDbStorageTest extends AbstractPartitionStorageTest {
- /**
- *
- */
private TableStorage table;
-
- /**
- *
- */
+
private DataRegion dataRegion;
/**
- *
+ * Before each.
*/
@BeforeEach
public void setUp(
@@ -83,7 +77,7 @@ public class RocksDbStorageTest extends AbstractPartitionStorageTest {
}
/**
- *
+ * After each.
*/
@AfterEach
public void tearDown() throws Exception {