fix: check styles on publisher-subscriber design pattern (#2898)

Author: sanurah

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/model/CustomerSupportContent.java

@@ -1,7 +1,7 @@
 package com.iluwatar.publish.subscribe.model;
 
 /**
- * This enum defines the content for {@link Topic} CUSTOMER_SUPPORT
+ * This enum defines the content for {@link Topic} CUSTOMER_SUPPORT.
  */
 public enum CustomerSupportContent {
 

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/model/Message.java

@@ -1,7 +1,7 @@
 package com.iluwatar.publish.subscribe.model;
 
 /**
- * This class represents a Message that holds the published content
+ * This class represents a Message that holds the published content.
  */
 public record Message(Object content) {
 }

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/model/Topic.java

@@ -5,7 +5,7 @@
 import java.util.concurrent.CopyOnWriteArraySet;
 
 /**
- * This class represents a Topic that topic name and subscribers
+ * This class represents a Topic that topic name and subscribers.
  */
 public class Topic {
 
@@ -22,7 +22,7 @@ public Topic(TopicName name) {
   }
 
   /**
-   * Get the name of the topic
+   * Get the name of the topic.
    *
    * @return topic name
    */
@@ -31,7 +31,7 @@ public TopicName getName() {
   }
 
   /**
-   * Add a subscriber to the list of subscribers
+   * Add a subscriber to the list of subscribers.
    *
    * @param subscriber subscriber to add
    */
@@ -40,7 +40,7 @@ public void addSubscriber(Subscriber subscriber) {
   }
 
   /**
-   * Remove a subscriber to the list of subscribers
+   * Remove a subscriber to the list of subscribers.
    *
    * @param subscriber subscriber to remove
    */
@@ -49,7 +49,7 @@ public void removeSubscriber(Subscriber subscriber) {
   }
 
   /**
-   * Publish a message to subscribers
+   * Publish a message to subscribers.
    *
    * @param message message with content to publish
    */

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/model/TopicName.java

@@ -1,7 +1,7 @@
 package com.iluwatar.publish.subscribe.model;
 
 /**
- * This enum defines the available topic names to be used in {@link Topic}
+ * This enum defines the available topic names to be used in {@link Topic}.
  */
 public enum TopicName {
   WEATHER,

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/model/WeatherContent.java

@@ -1,7 +1,7 @@
 package com.iluwatar.publish.subscribe.model;
 
 /**
- * This enum defines the content for {@link Topic} WEATHER
+ * This enum defines the content for {@link Topic} WEATHER.
  */
 public enum WeatherContent {
   earthquake("earthquake tsunami warning"),

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/publisher/Publisher.java

@@ -4,22 +4,22 @@
 import com.iluwatar.publish.subscribe.model.Topic;
 
 /**
- * This class represents a Publisher
+ * This class represents a Publisher.
  */
 public interface Publisher {
 
-    /**
-     * Register a topic in the publisher
-     *
-     * @param topic the topic to be registered
-     */
-    void registerTopic(Topic topic);
+  /**
+   * Register a topic in the publisher.
+   *
+   * @param topic the topic to be registered
+   */
+  void registerTopic(Topic topic);
 
-    /**
-     * Register a topic in the publisher
-     *
-     * @param topic the topic to publish the message under
-     * @param message message with content to be published
-     */
-    void publish(Topic topic, Message message);
+  /**
+   * Register a topic in the publisher.
+   *
+   * @param topic   the topic to publish the message under
+   * @param message message with content to be published
+   */
+  void publish(Topic topic, Message message);
 }

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/publisher/PublisherImpl.java

@@ -8,7 +8,7 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * This class is an implementation of the Publisher
+ * This class is an implementation of the Publisher.
  */
 public class PublisherImpl implements Publisher {
 

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/subscriber/Subscriber.java

@@ -3,12 +3,12 @@
 import com.iluwatar.publish.subscribe.model.Message;
 
 /**
- * This class represents a Subscriber
+ * This class represents a Subscriber.
  */
 public interface Subscriber {
 
   /**
-   * On message method will trigger when the subscribed event is published
+   * On message method will trigger when the subscribed event is published.
    *
    * @param message the message contains the content of the published event
    */

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/subscriber/WeatherSubscriber.java

@@ -8,7 +8,7 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * This class subscribes to WEATHER topic
+ * This class subscribes to WEATHER topic.
  */
 @Slf4j
 public class WeatherSubscriber implements Subscriber {