fix: fix documentation on publisher-subscriber design pattern (iluwatar#2898)

Author: sanurah

publish-subscribe/README.md

@@ -1,5 +1,5 @@
 ---
-title: "Publisher-Subscriber Pattern in Java: Decoupling the solution with asynchronous communication"
+title: "Publish-Subscribe Pattern in Java: Decoupling the solution with asynchronous communication"
 shortTitle: Proxy
 description: "Explore the Proxy design pattern in Java with detailed examples. Learn how it provides controlled access, facilitates lazy initialization, and ensures security. Ideal for developers looking to implement advanced Java techniques."
 category: Structural
@@ -14,14 +14,14 @@ tag:
     - Wrapping
 ---
 
-## Intent of the Publisher-Subscriber Design Pattern
+## Intent of the Publish-Subscribe Design Pattern
 
-The publisher-subscriber design pattern is widely used in software architecture to transmit data between various components in a system.
+The Publish-Subscriber design pattern is widely used in software architecture to transmit data between various components in a system.
 It is a behavioral design pattern aimed at achieving loosely coupled communication between objects.
 The primary intent is to allow a one-to-many dependency relationship where one object (the Publisher) notifies multiple other objects (the Subscribers) about changes or events,
 without needing to know who or what the subscribers are.
 
-## Detailed Explanation of Publisher-Subscriber Pattern with Real-World Examples
+## Detailed Explanation of Publish-Subscribe Pattern with Real-World Examples
 
 - Messaging systems like Kafka, RabbitMQ, AWS SNS, JMS
     - **Kafka** : publishes messages to topics and subscribers consumes them in real time for analytics, logs or other purposes.
@@ -38,7 +38,7 @@ without needing to know who or what the subscribers are.
     - **Publisher** : Writes a new blog post and publish to subscribers
     - **Subscribers** : All the subscribers to the newsletter receive the email
 
-## Programmatic Example of Publisher-Subscriber Pattern in Java
+## Programmatic Example of Publish-Subscribe Pattern in Java
 
 First we need to identify the Event on which we need the pub-sub methods to trigger.
 For example:
@@ -157,7 +157,7 @@ Program output:
 11:46:44.311 [main] INFO com.iluwatar.publish.subscribe.subscriber.CustomerSupportSubscriber - Subscriber: supportSub2 sent the email to: [email protected]
 ```
 
-## When to Use the Publisher-Subscriber Pattern
+## When to Use the Publish-Subscribe Pattern
 
 - Event-Driven Systems
     - Use Pub/Sub when your system relies on events (e.g., user registration, payment completion).
@@ -183,13 +183,13 @@ Program output:
     - Allow independent services to communicate without direct coupling.
     - Example: An order service publishes an event, and both the billing and shipping services process it.
 
-## When to avoid the Publisher-Subscriber Pattern
+## When to avoid the Publish-Subscribe Pattern
 
 - Simple applications where direct calls suffice.
 - Strong consistency requirements (e.g., banking transactions).
 - Low-latency synchronous communication needed.
 
-## Benefits and Trade-offs of Publisher-Subscriber Pattern
+## Benefits and Trade-offs of Publish-Subscribe Pattern
 
 ### Benefits:
 

publish-subscribe/src/main/java/com/iluwatar/publish/subscribe/App.java

@@ -27,14 +27,14 @@
  * added to the system without significant changes to the existing components, making the system
  * highly adaptable to evolving requirements.</li></p>
  *
- * <p>In this example we will create two topics {@link TopicName} WEATHER and CUSTOMER_SUPPORT.
- * then we will register those topics in {@link Publisher}
- * we will create two {@link WeatherSubscriber} to WEATHER {@link Topic}
- * we will create two {@link CustomerSupportSubscriber} to CUSTOMER_SUPPORT {@link Topic}
- * then we will publish the two {@link Topic} with different content in the {@link Message}
+ * <p>In this example we will create two {@link TopicName}s WEATHER and CUSTOMER_SUPPORT.
+ * Then we will register those topics in the {@link Publisher}.
+ * After that we will create two {@link WeatherSubscriber}s to WEATHER {@link Topic}.
+ * Also, we will create two {@link CustomerSupportSubscriber}s to CUSTOMER_SUPPORT {@link Topic}.
+ * Now we can publish the two {@link Topic}s with different content in the {@link Message}s.
  * And we can observe the output in the log where,
- * {@link WeatherSubscriber} publish the message with {@link WeatherContent}
- * {@link CustomerSupportSubscriber} publish the message with {@link CustomerSupportContent}
+ * {@link WeatherSubscriber} will output the message with {@link WeatherContent}.
+ * {@link CustomerSupportSubscriber} will output the message with {@link CustomerSupportContent}.
  * Each subscriber is only listening to the subscribed topic.
  */
 public class App {

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

@@ -1,8 +1,6 @@
 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 {
 
   DE("[email protected]"),

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

@@ -1,7 +1,5 @@
 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

@@ -4,9 +4,7 @@
 import java.util.Set;
 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 {
 
   private final TopicName name;

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

@@ -1,8 +1,6 @@
 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,
   CUSTOMER_SUPPORT

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

@@ -1,8 +1,6 @@
 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"),
   flood("flood start evacuation"),

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

@@ -3,9 +3,7 @@
 import com.iluwatar.publish.subscribe.model.Message;
 import com.iluwatar.publish.subscribe.model.Topic;
 
-/**
- * This class represents a Publisher.
- */
+/** This class represents a Publisher. */
 public interface Publisher {
 
   /**
@@ -18,7 +16,7 @@ public interface Publisher {
   /**
    * Register a topic in the publisher.
    *
-   * @param topic   the topic to publish the message under
+   * @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

@@ -7,9 +7,7 @@
 import org.slf4j.Logger;
 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 {
 
   private static final Logger logger = LoggerFactory.getLogger(PublisherImpl.class);

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

@@ -6,9 +6,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * This class subscribes to CUSTOMER_SUPPORT topic.
- */
+/** This class subscribes to CUSTOMER_SUPPORT topic. */
 @Slf4j
 public class CustomerSupportSubscriber implements Subscriber {
 

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

@@ -2,9 +2,7 @@
 
 import com.iluwatar.publish.subscribe.model.Message;
 
-/**
- * This class represents a Subscriber.
- */
+/** This class represents a Subscriber. */
 public interface Subscriber {
 
   /**

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

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