You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by am...@apache.org on 2021/06/04 13:59:49 UTC
[ignite-3] branch main updated: IGNITE-14562 Fix javadoc warnings
in network modules (#163)
This is an automated email from the ASF dual-hosted git repository.
amashenkov 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 6320257 IGNITE-14562 Fix javadoc warnings in network modules (#163)
6320257 is described below
commit 632025797ff14574531df1e41d69e580cf60e64a
Author: Alexander Polovtcev <al...@gmail.com>
AuthorDate: Fri Jun 4 16:59:36 2021 +0300
IGNITE-14562 Fix javadoc warnings in network modules (#163)
---
.../network/processor/internal/MessageClass.java | 22 +++++-----
.../processor/internal/MessageGroupWrapper.java | 13 +++---
.../processor/internal/ProcessingException.java | 17 ++++++--
.../network/processor/internal/TypeUtils.java | 18 ++++++--
.../internal/messages/MessageBuilderGenerator.java | 9 +++-
.../internal/messages/MessageFactoryGenerator.java | 8 +++-
.../internal/messages/MessageImplGenerator.java | 15 ++++---
.../serialization/BaseMethodNameResolver.java | 49 +++++++++-------------
.../MessageCollectionItemTypeConverter.java | 28 ++++++-------
.../MessageDeserializerGenerator.java | 8 +++-
.../serialization/MessageReaderMethodResolver.java | 7 +++-
.../serialization/MessageSerializerGenerator.java | 13 +++++-
.../serialization/MessageWriterMethodResolver.java | 7 +++-
.../RegistryInitializerGenerator.java | 9 +++-
.../SerializationFactoryGenerator.java | 10 ++++-
.../org/apache/ignite/network/ClusterNode.java | 12 ++----
.../ignite/network/annotations/Transferable.java | 4 +-
.../recovery/RecoveryClientHandshakeManager.java | 7 ++--
.../recovery/RecoveryServerHandshakeManager.java | 7 ++--
.../recovery/message/HandshakeStartMessage.java | 8 +++-
.../message/HandshakeStartResponseMessage.java | 16 +++++--
.../ScaleCubeDirectMarshallerTransport.java | 7 ++--
22 files changed, 185 insertions(+), 109 deletions(-)
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageClass.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageClass.java
index e75beb9..acdcd8a 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageClass.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageClass.java
@@ -65,77 +65,77 @@ public class MessageClass {
}
/**
- * Annotated element.
+ * @return annotated element
*/
public TypeElement element() {
return element;
}
/**
- * Class name of the {@link #element()}.
+ * @return class name of the {@link #element()}
*/
public ClassName className() {
return className;
}
/**
- * Package name of the {@link #element()}.
+ * @return package name of the {@link #element()}
*/
public String packageName() {
return className.packageName();
}
/**
- * Simple name of the {@link #element()}.
+ * @return simple name of the {@link #element()}
*/
public String simpleName() {
return className.simpleName();
}
/**
- * Getter methods declared in the annotated interface.
+ * @return getter methods declared in the annotated interface
*/
public List<ExecutableElement> getters() {
return getters;
}
/**
- * Returns the 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");
}
/**
- * Returns the 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 the 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() {
return decapitalize(simpleName());
}
/**
- * Returns {@link Transferable#value()}.
+ * @return {@link Transferable#value()}
*/
public short messageType() {
return annotation.value();
}
/**
- * Returns {@link Transferable#autoSerializable()}.
+ * @return {@link Transferable#autoSerializable()}
*/
public boolean isAutoSerializable() {
return annotation.autoSerializable();
}
/**
- * 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/network/processor/internal/MessageGroupWrapper.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageGroupWrapper.java
index 6c28e97..2e189b1 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageGroupWrapper.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/MessageGroupWrapper.java
@@ -35,7 +35,7 @@ public class MessageGroupWrapper {
private final MessageGroup annotation;
/**
- * @param messageGroup Element annotated with {@link MessageGroup}.
+ * @param messageGroup element annotated with {@link MessageGroup}
*/
public MessageGroupWrapper(TypeElement messageGroup) {
element = messageGroup;
@@ -46,33 +46,36 @@ public class MessageGroupWrapper {
throw new ProcessingException("Group type must not be negative", null, element);
}
+ /**
+ * @return element that this class wraps
+ */
public TypeElement element() {
return element;
}
/**
- * Returns the package name of the annotated element.
+ * @return package name of the annotated element.
*/
public String packageName() {
return className.packageName();
}
/**
- * Returns the {@link MessageGroup#groupName()} declared in the annotation.
+ * @return {@link MessageGroup#groupName()}
*/
public String groupName() {
return capitalize(annotation.groupName());
}
/**
- * Returns the {@link MessageGroup#groupType()} declared in the annotation.
+ * @return {@link MessageGroup#groupType()}
*/
public short groupType() {
return annotation.groupType();
}
/**
- * Returns the 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/network/processor/internal/ProcessingException.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/ProcessingException.java
index b9b6381..b7840d3 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/ProcessingException.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/ProcessingException.java
@@ -28,17 +28,26 @@ public class ProcessingException extends RuntimeException {
@Nullable
private final Element element;
- /** */
+ /**
+ * @param message message
+ */
public ProcessingException(String message) {
this(message, null, null);
}
- /** */
+ /**
+ * @param message message
+ * @param cause cause
+ */
public ProcessingException(String message, @Nullable Throwable cause) {
this(message, cause, null);
}
- /** */
+ /**
+ * @param message message
+ * @param cause cause
+ * @param element element which processing triggered the exception
+ */
public ProcessingException(String message, @Nullable Throwable cause, @Nullable Element element) {
super(message, cause);
@@ -46,7 +55,7 @@ public class ProcessingException extends RuntimeException {
}
/**
- * An 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/network/processor/internal/TypeUtils.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/TypeUtils.java
index f3eebab..7d1e530 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/TypeUtils.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/TypeUtils.java
@@ -33,13 +33,19 @@ public class TypeUtils {
/** */
private final ProcessingEnvironment processingEnvironment;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ */
public TypeUtils(ProcessingEnvironment processingEnvironment) {
this.processingEnvironment = processingEnvironment;
}
/**
* Returns {@code true} if the <i>erasure</i> of the given types are actually the same type.
+ *
+ * @param type1 first type (represented by a mirror)
+ * @param type2 second type (represented by a {@code Class})
+ * @return {@code true} if the erasure of both types represent the same type, {@code false} otherwise.
*/
public boolean isSameType(TypeMirror type1, Class<?> type2) {
TypeMirror type2Mirror = typeMirrorFromClass(type2);
@@ -50,6 +56,9 @@ public class TypeUtils {
/**
* Returns the primitive type represented by its boxed value or {@code null} if the given type is not a boxed
* primitive type.
+ *
+ * @param type boxed wrapper of a primitive type
+ * @return corresponding primitive type
*/
@Nullable
public PrimitiveType unboxedType(TypeMirror type) {
@@ -64,6 +73,10 @@ public class TypeUtils {
/**
* Returns {@code true} if the given type element implements the given interface (represented by its {@link Class})
* either directly or indirectly.
+ *
+ * @param element element which parent interfaces are to be inspected
+ * @param cls target superinterface to search for
+ * @return {@code true} if the given {@code element} is a subtype of {@code cls}
*/
public boolean hasSuperInterface(TypeElement element, Class<?> cls) {
// perform BFS to find the given interface among all possible superinterfaces
@@ -74,9 +87,8 @@ public class TypeUtils {
while (!queue.isEmpty()) {
Element currentElement = queue.pop();
- if (isSameType(currentElement.asType(), cls)) {
+ if (isSameType(currentElement.asType(), cls))
return true;
- }
((TypeElement)currentElement).getInterfaces().stream()
.map(processingEnvironment.getTypeUtils()::asElement)
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageBuilderGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageBuilderGenerator.java
index 8cc1227..483d241 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageBuilderGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageBuilderGenerator.java
@@ -36,9 +36,13 @@ public class MessageBuilderGenerator {
/** */
private final ProcessingEnvironment processingEnvironment;
+ /** Message group. */
private final MessageGroupWrapper messageGroup;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ * @param messageGroup message group
+ */
public MessageBuilderGenerator(
ProcessingEnvironment processingEnvironment, MessageGroupWrapper messageGroup
) {
@@ -48,6 +52,9 @@ public class MessageBuilderGenerator {
/**
* Generates a Builder interface for constructing the given Network Message.
+ *
+ * @param message network message
+ * @return {@code TypeSpec} of the generated Builder interface
*/
public TypeSpec generateBuilderInterface(MessageClass message) {
ClassName builderName = message.builderClassName();
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageFactoryGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageFactoryGenerator.java
index 703381f..88a2c8e 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageFactoryGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageFactoryGenerator.java
@@ -37,7 +37,10 @@ public class MessageFactoryGenerator {
/** Message group. */
private final MessageGroupWrapper messageGroup;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ * @param messageGroup message group
+ */
public MessageFactoryGenerator(
ProcessingEnvironment processingEnvironment,
MessageGroupWrapper messageGroup
@@ -48,6 +51,9 @@ public class MessageFactoryGenerator {
/**
* Generates a factory for all Network Messages inside the given module.
+ *
+ * @param messages Network Messages from a module
+ * @return {@code TypeSpec} of the generated message factory
*/
public TypeSpec generateMessageFactory(List<MessageClass> messages) {
ClassName factoryName = messageGroup.messageFactoryClassName();
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageImplGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageImplGenerator.java
index a474118..aaae542 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageImplGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/messages/MessageImplGenerator.java
@@ -44,18 +44,21 @@ public class MessageImplGenerator {
/** Message group. */
private final MessageGroupWrapper messageGroup;
- /** */
- public MessageImplGenerator(
- ProcessingEnvironment processingEnv,
-
- MessageGroupWrapper messageGroup
- ) {
+ /**
+ * @param processingEnv processing environment
+ * @param messageGroup message group
+ */
+ public MessageImplGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
this.messageGroup = messageGroup;
}
/**
* Generates the implementation of a given Network Message interface and its Builder (as a nested class).
+ *
+ * @param message network message
+ * @param builderInterface generated builder interface
+ * @return {@code TypeSpec} of the generated message implementation
*/
public TypeSpec generateMessageImpl(MessageClass message, TypeSpec builderInterface) {
ClassName messageImplClassName = message.implClassName();
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/BaseMethodNameResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/BaseMethodNameResolver.java
index aa95b12..e08154e 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/BaseMethodNameResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/BaseMethodNameResolver.java
@@ -42,27 +42,28 @@ class BaseMethodNameResolver {
/** */
private final ProcessingEnvironment processingEnvironment;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ */
BaseMethodNameResolver(ProcessingEnvironment processingEnvironment) {
this.processingEnvironment = processingEnvironment;
}
/**
* Resolves a "base" part of a (de-)serialization method.
+ *
+ * @param parameterType parameter of the method to resolve
+ * @return part of the method name, depending on the parameter type
*/
String resolveBaseMethodName(TypeMirror parameterType) {
- if (parameterType.getKind().isPrimitive()) {
+ if (parameterType.getKind().isPrimitive())
return resolvePrimitiveMethodName(parameterType);
- }
- else if (parameterType.getKind() == TypeKind.ARRAY) {
+ else if (parameterType.getKind() == TypeKind.ARRAY)
return resolveArrayMethodName((ArrayType)parameterType);
- }
- else if (parameterType.getKind() == TypeKind.DECLARED) {
+ else if (parameterType.getKind() == TypeKind.DECLARED)
return resolveReferenceMethodName((DeclaredType)parameterType);
- }
- else {
+ else
throw new ProcessingException("Unsupported type for message (de-)serialization: " + parameterType);
- }
}
/**
@@ -95,12 +96,10 @@ class BaseMethodNameResolver {
* Resolves a "base" part of a (de-)serialization method for the given array.
*/
private static String resolveArrayMethodName(ArrayType parameterType) {
- if (parameterType.getComponentType().getKind().isPrimitive()) {
+ if (parameterType.getComponentType().getKind().isPrimitive())
return resolvePrimitiveMethodName(parameterType.getComponentType()) + "Array";
- }
- else {
+ else
return "ObjectArray";
- }
}
/**
@@ -109,29 +108,21 @@ class BaseMethodNameResolver {
private String resolveReferenceMethodName(DeclaredType parameterType) {
var typeUtils = new TypeUtils(processingEnvironment);
- if (typeUtils.isSameType(parameterType, String.class)) {
+ if (typeUtils.isSameType(parameterType, String.class))
return "String";
- }
- else if (typeUtils.isSameType(parameterType, UUID.class)) {
+ else if (typeUtils.isSameType(parameterType, UUID.class))
return "Uuid";
- }
- else if (typeUtils.isSameType(parameterType, IgniteUuid.class)) {
+ else if (typeUtils.isSameType(parameterType, IgniteUuid.class))
return "IgniteUuid";
- }
- else if (typeUtils.isSameType(parameterType, NetworkMessage.class)) {
+ else if (typeUtils.isSameType(parameterType, NetworkMessage.class))
return "Message";
- }
- else if (typeUtils.isSameType(parameterType, BitSet.class)) {
+ else if (typeUtils.isSameType(parameterType, BitSet.class))
return "BitSet";
- }
- else if (typeUtils.isSameType(parameterType, Collection.class)) {
+ else if (typeUtils.isSameType(parameterType, Collection.class))
return "Collection";
- }
- else if (typeUtils.isSameType(parameterType, Map.class)) {
+ else if (typeUtils.isSameType(parameterType, Map.class))
return "Map";
- }
- else {
+ else
throw new ProcessingException("Unsupported reference type for message (de-)serialization: " + parameterType);
- }
}
}
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageCollectionItemTypeConverter.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageCollectionItemTypeConverter.java
index cc8c2e4..e7b645e 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageCollectionItemTypeConverter.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageCollectionItemTypeConverter.java
@@ -37,7 +37,9 @@ class MessageCollectionItemTypeConverter {
/** */
private final ProcessingEnvironment processingEnvironment;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ */
MessageCollectionItemTypeConverter(ProcessingEnvironment processingEnvironment) {
this.processingEnvironment = processingEnvironment;
}
@@ -70,6 +72,9 @@ class MessageCollectionItemTypeConverter {
/**
* Converts the given {@link TypeMirror} into a {@link MessageCollectionItemType}.
+ *
+ * @param parameterType type mirror
+ * @return corresponding {@code MessageCollectionItemType}
*/
MessageCollectionItemType fromTypeMirror(TypeMirror parameterType) {
switch (parameterType.getKind()) {
@@ -106,26 +111,19 @@ class MessageCollectionItemTypeConverter {
PrimitiveType unboxedType = typeUtils.unboxedType(parameterType);
- if (unboxedType != null) {
+ if (unboxedType != null)
return fromTypeMirror(unboxedType);
- }
- else if (typeUtils.isSameType(parameterType, String.class)) {
+ else if (typeUtils.isSameType(parameterType, String.class))
return MessageCollectionItemType.STRING;
- }
- else if (typeUtils.isSameType(parameterType, UUID.class)) {
+ else if (typeUtils.isSameType(parameterType, UUID.class))
return MessageCollectionItemType.UUID;
- }
- else if (typeUtils.isSameType(parameterType, IgniteUuid.class)) {
+ else if (typeUtils.isSameType(parameterType, IgniteUuid.class))
return MessageCollectionItemType.IGNITE_UUID;
- }
- else if (typeUtils.isSameType(parameterType, NetworkMessage.class)) {
+ else if (typeUtils.isSameType(parameterType, NetworkMessage.class))
return MessageCollectionItemType.MSG;
- }
- else if (typeUtils.isSameType(parameterType, BitSet.class)) {
+ else if (typeUtils.isSameType(parameterType, BitSet.class))
return MessageCollectionItemType.BIT_SET;
- }
- else {
+ else
throw new ProcessingException("Unsupported MessageCollectionItemType: " + parameterType);
- }
}
}
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageDeserializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageDeserializerGenerator.java
index f200ec3..3744c42 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageDeserializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageDeserializerGenerator.java
@@ -46,7 +46,10 @@ public class MessageDeserializerGenerator {
*/
private final MessageGroupWrapper messageGroup;
- /** */
+ /**
+ * @param processingEnv processing environment
+ * @param messageGroup message group
+ */
public MessageDeserializerGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
this.messageGroup = messageGroup;
@@ -54,6 +57,9 @@ public class MessageDeserializerGenerator {
/**
* Generates a {@link MessageDeserializer} class for the given network message type.
+ *
+ * @param message network message
+ * @return {@code TypeSpec} of the generated deserializer
*/
public TypeSpec generateDeserializer(MessageClass message) {
processingEnv.getMessager()
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageReaderMethodResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageReaderMethodResolver.java
index 25d1843..69750ae 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageReaderMethodResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageReaderMethodResolver.java
@@ -37,7 +37,9 @@ class MessageReaderMethodResolver {
/** */
private final MessageCollectionItemTypeConverter typeConverter;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ */
MessageReaderMethodResolver(ProcessingEnvironment processingEnvironment) {
methodNameResolver = new BaseMethodNameResolver(processingEnvironment);
typeConverter = new MessageCollectionItemTypeConverter(processingEnvironment);
@@ -45,6 +47,9 @@ class MessageReaderMethodResolver {
/**
* Resolves the "read" method by the type of the given message's builder method.
+ *
+ * @param getter getter method
+ * @return code for the method for reading the corresponding type of the getter
*/
CodeBlock resolveReadMethod(ExecutableElement getter) {
TypeMirror parameterType = getter.getReturnType();
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageSerializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageSerializerGenerator.java
index 05a4b15..cf4cfef 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageSerializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageSerializerGenerator.java
@@ -41,9 +41,13 @@ public class MessageSerializerGenerator {
/** */
private final ProcessingEnvironment processingEnvironment;
+ /** Message group. */
private final MessageGroupWrapper messageGroup;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ * @param messageGroup message group
+ */
public MessageSerializerGenerator(ProcessingEnvironment processingEnvironment, MessageGroupWrapper messageGroup) {
this.processingEnvironment = processingEnvironment;
this.messageGroup = messageGroup;
@@ -51,6 +55,9 @@ public class MessageSerializerGenerator {
/**
* Generates a {@link MessageSerializer} class for the given network message type.
+ *
+ * @param message network message
+ * @return {@code TypeSpec} of the generated serializer
*/
public TypeSpec generateSerializer(MessageClass message) {
processingEnvironment.getMessager()
@@ -80,7 +87,9 @@ public class MessageSerializerGenerator {
method
.beginControlFlow("if (!writer.isHeaderWritten())")
- .beginControlFlow("if (!writer.writeHeader(message.groupType(), message.messageType(), (byte) $L))", getters.size())
+ .beginControlFlow(
+ "if (!writer.writeHeader(message.groupType(), message.messageType(), (byte) $L))", getters.size()
+ )
.addStatement("return false")
.endControlFlow()
.addStatement("writer.onHeaderWritten()")
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageWriterMethodResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageWriterMethodResolver.java
index 93dbac4..4c3f5c5 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageWriterMethodResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/MessageWriterMethodResolver.java
@@ -41,7 +41,9 @@ class MessageWriterMethodResolver {
/** */
private final MessageCollectionItemTypeConverter typeConverter;
- /** */
+ /**
+ * @param processingEnvironment processing environment
+ */
MessageWriterMethodResolver(ProcessingEnvironment processingEnvironment) {
methodNameResolver = new BaseMethodNameResolver(processingEnvironment);
typeConverter = new MessageCollectionItemTypeConverter(processingEnvironment);
@@ -49,6 +51,9 @@ class MessageWriterMethodResolver {
/**
* Resolves the "write" method by the type of the given message's getter method.
+ *
+ * @param getter getter method
+ * @return code for the method for writing a field based on the getter type
*/
CodeBlock resolveWriteMethod(ExecutableElement getter) {
if (!getter.getParameters().isEmpty() || getter.getReturnType().getKind() == TypeKind.VOID) {
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/RegistryInitializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/RegistryInitializerGenerator.java
index 26d35c5..4a16a08 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/RegistryInitializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/RegistryInitializerGenerator.java
@@ -40,9 +40,13 @@ public class RegistryInitializerGenerator {
/** */
private final ProcessingEnvironment processingEnv;
+ /** Message group. */
private final MessageGroupWrapper messageGroup;
- /** */
+ /**
+ * @param processingEnv processing environment
+ * @param messageGroup message group
+ */
public RegistryInitializerGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
this.messageGroup = messageGroup;
@@ -50,6 +54,9 @@ public class RegistryInitializerGenerator {
/**
* Generates a class for registering all generated {@link MessageSerializationFactory} for the current module.
+ *
+ * @param messageFactories map from a network message to a corresponding {@code MessageSerializationFactory}
+ * @return {@code TypeSpec} of the generated registry initializer
*/
public TypeSpec generateRegistryInitializer(Map<MessageClass, TypeSpec> messageFactories) {
String initializerName = messageGroup.groupName() + "SerializationRegistryInitializer";
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/SerializationFactoryGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/SerializationFactoryGenerator.java
index 2438470..e10c976 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/SerializationFactoryGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/network/processor/internal/serialization/SerializationFactoryGenerator.java
@@ -41,7 +41,10 @@ public class SerializationFactoryGenerator {
/** Message group. */
private final MessageGroupWrapper messageGroup;
- /** */
+ /**
+ * @param processingEnv processing environment
+ * @param messageGroup message group
+ */
public SerializationFactoryGenerator(ProcessingEnvironment processingEnv, MessageGroupWrapper messageGroup) {
this.processingEnv = processingEnv;
this.messageGroup = messageGroup;
@@ -49,6 +52,11 @@ public class SerializationFactoryGenerator {
/**
* Generates a {@link MessageSerializationFactory} class for the given network message type.
+ *
+ * @param message network message
+ * @param serializer {@link MessageSerializer}, generated for the given {@code message}
+ * @param deserializer {@link MessageDeserializer}, generated for the given {@code message}
+ * @return {@code TypeSpec} of the generated {@code MessageSerializationFactory}
*/
public TypeSpec generateFactory(MessageClass message, TypeSpec serializer, TypeSpec deserializer) {
processingEnv.getMessager()
diff --git a/modules/network-api/src/main/java/org/apache/ignite/network/ClusterNode.java b/modules/network-api/src/main/java/org/apache/ignite/network/ClusterNode.java
index 205d924..026fdf8 100644
--- a/modules/network-api/src/main/java/org/apache/ignite/network/ClusterNode.java
+++ b/modules/network-api/src/main/java/org/apache/ignite/network/ClusterNode.java
@@ -40,14 +40,10 @@ public class ClusterNode implements Serializable {
private String address;
/**
- * @param id The id.
- * @param name The unique node name.
- * @param host The host.
- * @param port The port.
- * @param id Local id that changes between restarts.
- * @param name Unique name of member in cluster.
- * @param host Node host.
- * @param port Node port.
+ * @param id local id that changes between restarts
+ * @param name unique name of a member in a cluster
+ * @param host node host
+ * @param port node port
*/
public ClusterNode(String id, String name, String host, int port) {
this.id = id;
diff --git a/modules/network-api/src/main/java/org/apache/ignite/network/annotations/Transferable.java b/modules/network-api/src/main/java/org/apache/ignite/network/annotations/Transferable.java
index bea48a2..ac0e95e 100644
--- a/modules/network-api/src/main/java/org/apache/ignite/network/annotations/Transferable.java
+++ b/modules/network-api/src/main/java/org/apache/ignite/network/annotations/Transferable.java
@@ -84,13 +84,15 @@ import org.apache.ignite.network.serialization.MessageSerializer;
// TODO: Update this annotation according to https://issues.apache.org/jira/browse/IGNITE-14817
public @interface Transferable {
/**
- * This message's type as described in {@link NetworkMessage#messageType}.
+ * @return this message's type as described in {@link NetworkMessage#messageType}
*/
short value();
/**
* When this property is set to {@code true} (default), serialization-related classes will be generated in addition
* to the message implementation.
+ *
+ * @return {code true} if serialization classes need to be generated, {@code false} otherwise
*/
boolean autoSerializable() default true;
}
diff --git a/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryClientHandshakeManager.java b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryClientHandshakeManager.java
index ce674e7..1a0e8c3 100644
--- a/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryClientHandshakeManager.java
+++ b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryClientHandshakeManager.java
@@ -48,10 +48,9 @@ public class RecoveryClientHandshakeManager implements HandshakeManager {
private final NetworkMessagesFactory messageFactory;
/**
- * Constructor.
- *
- * @param launchId Launch id.
- * @param consistentId Consistent id.
+ * @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/network/internal/recovery/RecoveryServerHandshakeManager.java b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryServerHandshakeManager.java
index 8744167..05e54ab 100644
--- a/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryServerHandshakeManager.java
+++ b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/RecoveryServerHandshakeManager.java
@@ -48,10 +48,9 @@ public class RecoveryServerHandshakeManager implements HandshakeManager {
private final NetworkMessagesFactory messageFactory;
/**
- * Constructor.
- *
- * @param launchId Launch id.
- * @param consistentId Consistent id.
+ * @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/network/internal/recovery/message/HandshakeStartMessage.java b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartMessage.java
index 65828ed..d877ba7 100644
--- a/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartMessage.java
+++ b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartMessage.java
@@ -27,9 +27,13 @@ import org.apache.ignite.network.annotations.Transferable;
*/
@Transferable(NetworkMessageTypes.HANDSHAKE_START)
public interface HandshakeStartMessage extends NetworkMessage {
- /** Launch id. */
+ /**
+ * @return launch id
+ */
UUID launchId();
- /** Consistent id. */
+ /**
+ * @return consistent id
+ */
String consistentId();
}
diff --git a/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartResponseMessage.java b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartResponseMessage.java
index 5ec3383..d2c4096 100644
--- a/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartResponseMessage.java
+++ b/modules/network/src/main/java/org/apache/ignite/network/internal/recovery/message/HandshakeStartResponseMessage.java
@@ -27,15 +27,23 @@ import org.apache.ignite.network.annotations.Transferable;
*/
@Transferable(NetworkMessageTypes.HANDSHAKE_START_RESPONSE)
public interface HandshakeStartResponseMessage extends NetworkMessage {
- /** Launch id. */
+ /**
+ * @return launch id
+ */
UUID launchId();
- /** Consistent id. */
+ /**
+ * @return consistent id
+ */
String consistentId();
- /** Number of received messages. */
+ /**
+ * @return number of received messages
+ */
long receivedCount();
- /** Connections count. */
+ /**
+ * @return connections count
+ */
long connectionsCount();
}
diff --git a/modules/network/src/main/java/org/apache/ignite/network/scalecube/ScaleCubeDirectMarshallerTransport.java b/modules/network/src/main/java/org/apache/ignite/network/scalecube/ScaleCubeDirectMarshallerTransport.java
index 1cca68b..50d9e82 100644
--- a/modules/network/src/main/java/org/apache/ignite/network/scalecube/ScaleCubeDirectMarshallerTransport.java
+++ b/modules/network/src/main/java/org/apache/ignite/network/scalecube/ScaleCubeDirectMarshallerTransport.java
@@ -78,10 +78,9 @@ public class ScaleCubeDirectMarshallerTransport implements Transport {
private Address address;
/**
- * Constructor.
- *
- * @param connectionManager Connection manager.
- * @param topologyService Topology service.
+ * @param connectionManager connection manager
+ * @param topologyService topology service
+ * @param messageFactory message factory
*/
public ScaleCubeDirectMarshallerTransport(
ConnectionManager connectionManager,