v1.0.6

pom.xml

@@ -19,7 +19,7 @@
 
    <groupId>com.bernardomg.example</groupId>
    <artifactId>reactor-netty-tcp-client-example</artifactId>
-   <version>1.0.5</version>
+   <version>1.0.6</version>
    <packaging>jar</packaging>
 
    <name>Reactor Netty TCP Client Example</name>

readme.md

@@ -20,12 +20,6 @@ To show other commands:
 java -jar target/client.jar -h
 ```
 
-[![Release docs](https://img.shields.io/badge/docs-release-blue.svg)][site-release]
-[![Development docs](https://img.shields.io/badge/docs-develop-blue.svg)][site-develop]
-
-[![Release javadocs](https://img.shields.io/badge/javadocs-release-blue.svg)][javadoc-release]
-[![Development javadocs](https://img.shields.io/badge/javadocs-develop-blue.svg)][javadoc-develop]
-
 ## Other Netty examples
 
 ### TCP
@@ -40,10 +34,10 @@ java -jar target/client.jar -h
 - [Reactor Netty TCP Server Example](https://github.com/Bernardo-MG/reactor-netty-tcp-server-example)
 - [Reactor Netty TCP Proxy Example](https://github.com/Bernardo-MG/reactor-netty-tcp-proxy-example)
 
-### HTTP
+### HTTP Reactive
 
-- [Netty HTTP Client Example](https://github.com/Bernardo-MG/reactor-netty-http-client-example)
-- [Netty HTTP Server Example](https://github.com/Bernardo-MG/reactor-netty-http-server-example)
+- [Reactor Netty HTTP Client Example](https://github.com/Bernardo-MG/reactor-netty-http-client-example)
+- [Reactor Netty HTTP Server Example](https://github.com/Bernardo-MG/reactor-netty-http-server-example)
 
 ## Features
 
@@ -56,25 +50,13 @@ java -jar target/client.jar -h
 
 ## Documentation
 
-Documentation is always generated for the latest release, kept in the 'master' branch:
-
-- The [latest release documentation page][site-release].
-- The [latest release Javadoc site][javadoc-release].
-
-Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
-
-- The [the latest snapshot documentation page][site-develop].
-- The [latest snapshot Javadoc site][javadoc-develop].
-
-### Building the docs
-
-The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:
+The documentation site is actually a Maven site, its sources are included in the project. Can be generated by using the following Maven command:
 
 ```
 mvn verify site
 ```
 
-The verify phase is required, otherwise some of the reports won't be generated.
+The verify phase is required, otherwise some of the reports won't be built.
 
 ## Collaborate
 
@@ -96,9 +78,5 @@ If you wish to fork or modify the code, visit the [GitHub project page][scm], wh
 The project has been released under the [MIT License][license].
 
 [issues]: https://github.com/bernardo-mg/reactor-netty-tcp-client-example/issues
-[javadoc-develop]: https://docs.bernardomg.com/development/maven/reactor-netty-tcp-client-example/apidocs
-[javadoc-release]: https://docs.bernardomg.com/maven/reactor-netty-tcp-client-example/apidocs
 [license]: https://www.opensource.org/licenses/mit-license.php
 [scm]: https://github.com/bernardo-mg/reactor-netty-tcp-client-example
-[site-develop]: https://docs.bernardomg.com/development/maven/reactor-netty-tcp-client-example
-[site-release]: https://docs.bernardomg.com/maven/reactor-netty-tcp-client-example

src/changes/changes.xml

@@ -42,5 +42,13 @@
                 Cleaned up code.
             </action>
         </release>
+        <release version="1.0.6" date="2023-05-11" description="Cleaned up docs">
+            <action dev="bmg" type="update">
+                Cleaned up readme.
+            </action>
+            <action dev="bmg" type="remove">
+                Docs are no longer deployed.
+            </action>
+        </release>
     </body>
 </document>

src/main/java/com/bernardomg/example/netty/tcp/cli/CliWriterTransactionListener.java → src/main/java/com/bernardomg/example/netty/tcp/cli/TransactionPrinterListener.java

@@ -30,12 +30,12 @@
 import com.bernardomg.example.netty.tcp.client.TransactionListener;
 
 /**
- * Transaction listener which will write the context of each step into the CLI console.
+ * Transaction listener which will write the context of each step into a {@link PrintWriter}.
  *
  * @author Bernardo Martínez Garrido
  *
  */
-public final class CliWriterTransactionListener implements TransactionListener {
+public final class TransactionPrinterListener implements TransactionListener {
 
     /**
      * Host for the server to which this client will connect.
@@ -48,11 +48,11 @@ public final class CliWriterTransactionListener implements TransactionListener {
     private final Integer     port;
 
     /**
-     * CLI writer, to print console messages.
+     * Print writer, where the messages will be sent.
      */
     private final PrintWriter writer;
 
-    public CliWriterTransactionListener(final String hst, final Integer prt, final PrintWriter wrt) {
+    public TransactionPrinterListener(final String hst, final Integer prt, final PrintWriter wrt) {
         super();
 
         port = Objects.requireNonNull(prt);

src/main/java/com/bernardomg/example/netty/tcp/cli/command/SendEmptyMessageCommand.java

@@ -32,7 +32,7 @@
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.core.config.Configurator;
 
-import com.bernardomg.example.netty.tcp.cli.CliWriterTransactionListener;
+import com.bernardomg.example.netty.tcp.cli.TransactionPrinterListener;
 import com.bernardomg.example.netty.tcp.cli.version.ManifestVersionProvider;
 import com.bernardomg.example.netty.tcp.client.Client;
 import com.bernardomg.example.netty.tcp.client.ReactorNettyTcpClient;
@@ -60,7 +60,7 @@ public final class SendEmptyMessageCommand implements Runnable {
      * Debug flag. Shows debug logs.
      */
     @Option(names = { "--debug" }, paramLabel = "flag", description = "Enable debug logs.", defaultValue = "false")
-    private Boolean     debug;
+    private boolean     debug;
 
     /**
      * Server host.
@@ -85,7 +85,7 @@ public final class SendEmptyMessageCommand implements Runnable {
      */
     @Option(names = { "--verbose" }, paramLabel = "flag", description = "Print information to console.",
             defaultValue = "true", showDefaultValue = Help.Visibility.ALWAYS)
-    private Boolean     verbose;
+    private boolean     verbose;
 
     /**
      * Response wait time. This is the number of seconds to wait for responses.
@@ -122,7 +122,7 @@ public final void run() {
         }
 
         // Create client
-        listener = new CliWriterTransactionListener(host, port, writer);
+        listener = new TransactionPrinterListener(host, port, writer);
         client = new ReactorNettyTcpClient(host, port, listener, debug);
 
         client.connect();

src/main/java/com/bernardomg/example/netty/tcp/cli/command/SendMessageCommand.java

@@ -32,7 +32,7 @@
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.core.config.Configurator;
 
-import com.bernardomg.example.netty.tcp.cli.CliWriterTransactionListener;
+import com.bernardomg.example.netty.tcp.cli.TransactionPrinterListener;
 import com.bernardomg.example.netty.tcp.cli.version.ManifestVersionProvider;
 import com.bernardomg.example.netty.tcp.client.Client;
 import com.bernardomg.example.netty.tcp.client.ReactorNettyTcpClient;
@@ -60,7 +60,7 @@ public final class SendMessageCommand implements Runnable {
      * Debug flag. Shows debug logs.
      */
     @Option(names = { "--debug" }, paramLabel = "flag", description = "Enable debug logs.", defaultValue = "false")
-    private Boolean     debug;
+    private boolean     debug;
 
     /**
      * Server host.
@@ -91,7 +91,7 @@ public final class SendMessageCommand implements Runnable {
      */
     @Option(names = { "--verbose" }, paramLabel = "flag", description = "Print information to console.",
             defaultValue = "true", showDefaultValue = Help.Visibility.ALWAYS)
-    private Boolean     verbose;
+    private boolean     verbose;
 
     /**
      * Response wait time. This is the number of seconds to wait for responses.
@@ -128,7 +128,7 @@ public final void run() {
         }
 
         // Create client
-        listener = new CliWriterTransactionListener(host, port, writer);
+        listener = new TransactionPrinterListener(host, port, writer);
         client = new ReactorNettyTcpClient(host, port, listener, debug);
 
         client.connect();

src/main/java/com/bernardomg/example/netty/tcp/cli/command/SendMultipleMessagesCommand.java

@@ -32,7 +32,7 @@
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.core.config.Configurator;
 
-import com.bernardomg.example.netty.tcp.cli.CliWriterTransactionListener;
+import com.bernardomg.example.netty.tcp.cli.TransactionPrinterListener;
 import com.bernardomg.example.netty.tcp.cli.version.ManifestVersionProvider;
 import com.bernardomg.example.netty.tcp.client.Client;
 import com.bernardomg.example.netty.tcp.client.ReactorNettyTcpClient;
@@ -60,7 +60,7 @@ public final class SendMultipleMessagesCommand implements Runnable {
      * Debug flag. Shows debug logs.
      */
     @Option(names = { "--debug" }, paramLabel = "flag", description = "Enable debug logs.", defaultValue = "false")
-    private Boolean     debug;
+    private boolean     debug;
 
     /**
      * Server host.
@@ -85,7 +85,7 @@ public final class SendMultipleMessagesCommand implements Runnable {
      */
     @Option(names = { "--verbose" }, paramLabel = "flag", description = "Print information to console.",
             defaultValue = "true", showDefaultValue = Help.Visibility.ALWAYS)
-    private Boolean     verbose;
+    private boolean     verbose;
 
     /**
      * Response wait time. This is the number of seconds to wait for responses.
@@ -122,7 +122,7 @@ public final void run() {
         }
 
         // Create client
-        listener = new CliWriterTransactionListener(host, port, writer);
+        listener = new TransactionPrinterListener(host, port, writer);
         client = new ReactorNettyTcpClient(host, port, listener, debug);
 
         client.connect();