Add readme and JavaDocs

Author: xxlabaza

.codestyle/checkstyle.xml

@@ -71,7 +71,7 @@ limitations under the License.
 
     <!-- Checks for Javadoc comments.                     -->
     <!-- See http://checkstyle.sf.net/config_javadoc.html -->
-    <!-- <module name="JavadocMethod">
+    <module name="JavadocMethod">
       <property name="scope" value="protected"/>
       <property name="allowedAnnotations" value="Override, Test"/>
       <property name="allowThrowsTagsForSubclasses" value="true"/>
@@ -90,15 +90,14 @@ limitations under the License.
     <module name="SummaryJavadoc">
       <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
     </module>
-    <module name="JavadocParagraph"/>
     <module name="SingleLineJavadoc">
       <property name="ignoreInlineTags" value="false"/>
     </module>
     <module name="AtclauseOrder">
       <property name="tagOrder" value="@param, @return, @throws, @see, @since, @author, @version, @deprecated"/>
       <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
     </module>
-    <module name="NonEmptyAtclauseDescription"/> -->
+    <module name="NonEmptyAtclauseDescription"/>
 
 
     <!-- Checks for Naming Conventions.                  -->

CHANGELOG.md

@@ -11,6 +11,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Add more unit and integration tests.
 
+## [1.0.2](https://github.com/appulse-projects/epmd-java/releases/tag/1.0.2) - 2018-06-06
+
+Code refactoring.
+
+### Added
+
+- JavaDoc comments.
+- `README.md` content.
+
 ## [1.0.1](https://github.com/appulse-projects/epmd-java/releases/tag/1.0.1) - 2018-03-23
 
 Small refactoring.

README.md

@@ -3,7 +3,7 @@
 [![build_status](https://travis-ci.org/appulse-projects/epmd-java.svg?branch=master)](https://travis-ci.org/appulse-projects/epmd-java)
 [![maven_central](https://maven-badges.herokuapp.com/maven-central/io.appulse/epmd-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.appulse/epmd-java)
 
-This is the set of projects, which implementing EPMD server and client.
+This is the set of projects, which implementing EPMD server and its client.
 
 - [Core description](./core/README.md)
 - [Client description](./client/README.md)

client/README.md

@@ -14,7 +14,7 @@ Include the dependency to your project's pom.xml file:
     <dependency>
         <groupId>io.appulse.epmd.java</groupId>
         <artifactId>client</artifactId>
-        <version>1.0.1</version>
+        <version>1.0.2</version>
     </dependency>
     ...
 </dependencies>
@@ -23,7 +23,7 @@ Include the dependency to your project's pom.xml file:
 or Gradle:
 
 ```groovy
-compile 'io.appulse.epmd.java:client:1.0.1'
+compile 'io.appulse.epmd.java:client:1.0.2'
 ```
 
 ### Create client

client/pom.xml

@@ -25,7 +25,7 @@ limitations under the License.
   <parent>
     <groupId>io.appulse</groupId>
     <artifactId>epmd-java</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
   </parent>
 
   <groupId>io.appulse.epmd.java</groupId>
@@ -43,7 +43,7 @@ limitations under the License.
     <dependency>
       <groupId>org.testcontainers</groupId>
       <artifactId>testcontainers</artifactId>
-      <version>1.6.0</version>
+      <version>1.7.3</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

client/src/main/java/io/appulse/epmd/java/client/Connection.java

@@ -39,9 +39,10 @@
 import lombok.val;
 
 /**
+ * EPMD connection.
  *
- * @author Artem Labazin
  * @since 0.2.2
+ * @author Artem Labazin
  */
 @Slf4j
 @RequiredArgsConstructor
@@ -70,7 +71,7 @@ class Connection implements Closeable {
 
   Socket socket = new Socket();
 
-  public void send (@NonNull Object request) throws EpmdConnectionException {
+  void send (@NonNull Object request) throws EpmdConnectionException {
     log.debug("Sending: {}", request);
 
     val bytes = SERIALIZER.serialize(request);
@@ -87,7 +88,7 @@ public void send (@NonNull Object request) throws EpmdConnectionException {
     log.debug("Message {} was sent", request);
   }
 
-  public <T> T send (@NonNull Object request, @NonNull Class<T> responseType) throws EpmdConnectionException {
+  <T> T send (@NonNull Object request, @NonNull Class<T> responseType) throws EpmdConnectionException {
     send(request);
 
     byte[] messageBytes;
@@ -120,11 +121,11 @@ public void close () {
               socket.getLocalPort(), socket.getRemoteSocketAddress());
   }
 
-  public boolean isClosed () {
+  boolean isClosed () {
     return socket.isClosed();
   }
 
-  public boolean isConnected () {
+  boolean isConnected () {
     return socket.isConnected();
   }
 

client/src/main/java/io/appulse/epmd/java/client/EpmdClient.java

@@ -48,8 +48,8 @@
 /**
  * EPMD client.
  *
- * @author Artem Labazin
  * @since 0.2.2
+ * @author Artem Labazin
  */
 @Slf4j
 @FieldDefaults(level = PRIVATE, makeFinal = true)
@@ -67,18 +67,44 @@ public final class EpmdClient implements Closeable {
 
   Integer port;
 
+  /**
+   * Default no arguments constructor.
+   * <p>
+   * It uses default inet address (localhost) and port (4369).
+   */
   public EpmdClient () {
     this(Default.ADDRESS, Default.PORT);
   }
 
+  /**
+   * Constructs EPMD client with the specified {@link InetAddress}.
+   * <p>
+   * It uses default port (4369).
+   *
+   * @param address EPMD server address
+   */
   public EpmdClient (InetAddress address) {
     this(address, Default.PORT);
   }
 
+  /**
+   * Constructs EPMD client with the specified port.
+   * <p>
+   * It uses default inet address (localhost).
+   *
+   * @param port EPMD server port
+   */
   public EpmdClient (int port) {
     this(Default.ADDRESS, port);
   }
 
+  /**
+   * Constructs EPMD client with the specified address and port.
+   *
+   * @param address EPMD server address
+   *
+   * @param port EPMD server port
+   */
   @Builder
   public EpmdClient (@NonNull InetAddress address, int port) {
     lookupService = new LookupService(address, port);
@@ -88,6 +114,23 @@ public EpmdClient (@NonNull InetAddress address, int port) {
     log.debug("Instantiated EPMD client to '{}:{}'", address, port);
   }
 
+  /**
+   * Registers node at EPMD server.
+   *
+   * @param name node name
+   *
+   * @param nodePort node port
+   *
+   * @param type node type
+   *
+   * @param protocol node protocol
+   *
+   * @param low lowest supported distribution protocol version
+   *
+   * @param high highest supported distribution protocol version
+   *
+   * @return creation id from EPMD
+   */
   public int register (String name, int nodePort, NodeType type, Protocol protocol, Version low, Version high) {
     val request = Registration.builder()
         .name(name)
@@ -101,6 +144,13 @@ public int register (String name, int nodePort, NodeType type, Protocol protocol
     return register(request);
   }
 
+  /**
+   * Registers node at EPMD server.
+   *
+   * @param request registration holder
+   *
+   * @return creation id from EPMD
+   */
   public int register (@NonNull Registration request) {
     if (cache.containsKey(request.getName()) && cache.get(request.getName()).isConnected()) {
       log.error("Node with name '{}' already exists");
@@ -129,13 +179,23 @@ public int register (@NonNull Registration request) {
     return response.getCreation();
   }
 
+  /**
+   * Returns nodes infos from EPMD.
+   *
+   * @return list of nodes from EPMD
+   */
   public List<EpmdDump.NodeDump> dumpAll () {
     try (val connection = new Connection(address, port)) {
       val dump = connection.send(new GetEpmdDump(), EpmdDump.class);
       return dump.getNodes();
     }
   }
 
+  /**
+   * Stops a node by name.
+   *
+   * @param node node's name
+   */
   public void stop (@NonNull String node) {
     try (val connection = new Connection(address, port)) {
       connection.send(new Stop(node));
@@ -171,10 +231,19 @@ protected void finalize () throws Throwable {
     super.finalize();
   }
 
+  /**
+   * EPMD client defaults.
+   */
   public static class Default {
 
+    /**
+     * Default EPMD client address (localhost).
+     */
     public static final InetAddress ADDRESS = getDefaultInetAddress();
 
+    /**
+     * Default EPMD client port (4369).
+     */
     public static final int PORT = getDefaultPort();
 
     @SneakyThrows

client/src/main/java/io/appulse/epmd/java/client/LookupService.java

@@ -33,9 +33,10 @@
 import lombok.val;
 
 /**
+ * Service for searching {@link NodeInfo} by node name.
  *
- * @author Artem Labazin
  * @since 0.2.2
+ * @author Artem Labazin
  */
 @Slf4j
 @RequiredArgsConstructor

client/src/main/java/io/appulse/epmd/java/client/NodesLocatorService.java

@@ -32,9 +32,10 @@
 import lombok.val;
 
 /**
+ * Service for retrieving node descriptions at EPMD server.
  *
- * @author Artem Labazin
  * @since 0.2.2
+ * @author Artem Labazin
  */
 @Slf4j
 @RequiredArgsConstructor

client/src/main/java/io/appulse/epmd/java/client/exception/EpmdConnectionException.java

@@ -17,22 +17,61 @@
 package io.appulse.epmd.java.client.exception;
 
 /**
+ * Error during EPMD connection.
  *
- * @author Artem Labazin
  * @since 0.2.2
+ * @author Artem Labazin
  */
 public class EpmdConnectionException extends RuntimeException {
 
   private static final long serialVersionUID = -1017832971745823012L;
 
+  /**
+   * Constructs a new runtime exception with null as its detail message.
+   * <p>
+   * The cause is not initialized, and may subsequently be initialized
+   * by a call to Throwable.initCause(java.lang.Throwable).
+   */
+  public EpmdConnectionException () {
+    super();
+  }
+
+  /**
+   * Constructs a new runtime exception with null as its detail message.
+   * <p>
+   * The cause is not initialized, and may subsequently be initialized
+   * by a call to Throwable.initCause(java.lang.Throwable).
+   *
+   * @param message the detail message.
+   */
   public EpmdConnectionException (String message) {
     super(message);
   }
 
+  /**
+   * Constructs a new runtime exception with the specified detail message.
+   * <p>
+   * The cause is not initialized, and may subsequently be initialized
+   * by a call to Throwable.initCause(java.lang.Throwable).
+   *
+   * @param message the detail message.
+   *
+   * @param cause the cause (which is saved for later retrieval by the Throwable.getCause() method).
+   *              (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
+   */
   public EpmdConnectionException (String message, Throwable cause) {
     super(message, cause);
   }
 
+  /**
+   * Constructs a new runtime exception with the specified cause and a detail message
+   * of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
+   * <p>
+   * This constructor is useful for runtime exceptions that are little more than wrappers for other throwables.
+   *
+   * @param cause the cause (which is saved for later retrieval by the Throwable.getCause() method).
+   *              (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
+   */
   public EpmdConnectionException (Throwable cause) {
     super(cause);
   }