fix: apply spotless on publisher-subscriber design pattern (#2898)

Author: sanurah

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

@@ -12,30 +12,31 @@
 import com.iluwatar.publish.subscribe.subscriber.WeatherSubscriber;
 
 /**
- * <p>The Publish and Subscribe pattern is a messaging paradigm used in software architecture with
- * several key points: <li>Decoupling of publishers and subscribers: Publishers and subscribers
- * operate independently, and there's no direct link between them. This enhances the scalability and
- * * modularity of applications.</li><li>Event-driven communication: The pattern facilitates
- * event-driven architectures by allowing publishers to broadcast events without concerning
- * themselves with who receives the events.</li><li>Dynamic subscription: Subscribers can
- * dynamically choose to listen for specific events or messages they are interested in, often by
- * subscribing to a particular topic or channel.</li><li>Asynchronous processing: The pattern
- * inherently supports asynchronous message processing, enabling efficient handling of events and
- * improving application responsiveness.</li><li>Scalability: By decoupling senders and receivers,
- * the pattern can support a large number of publishers and subscribers, making it suitable for
- * scalable systems.</li><li>Flexibility and adaptability: New subscribers or publishers can be
- * added to the system without significant changes to the existing components, making the system
- * highly adaptable to evolving requirements.</li></p>
+ * The Publish and Subscribe pattern is a messaging paradigm used in software architecture with
+ * several key points:
+ * <li>Decoupling of publishers and subscribers: Publishers and subscribers operate independently,
+ *     and there's no direct link between them. This enhances the scalability and * modularity of
+ *     applications.
+ * <li>Event-driven communication: The pattern facilitates event-driven architectures by allowing
+ *     publishers to broadcast events without concerning themselves with who receives the events.
+ * <li>Dynamic subscription: Subscribers can dynamically choose to listen for specific events or
+ *     messages they are interested in, often by subscribing to a particular topic or channel.
+ * <li>Asynchronous processing: The pattern inherently supports asynchronous message processing,
+ *     enabling efficient handling of events and improving application responsiveness.
+ * <li>Scalability: By decoupling senders and receivers, the pattern can support a large number of
+ *     publishers and subscribers, making it suitable for scalable systems.
+ * <li>Flexibility and adaptability: New subscribers or publishers can be added to the system
+ *     without significant changes to the existing components, making the system highly adaptable to
+ *     evolving requirements.
  *
- * <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} 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.
+ *     <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} 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 {
 
@@ -71,4 +72,4 @@ public static void main(String[] args) {
     publisher.publish(weatherTopic, new Message(WeatherContent.earthquake));
     publisher.publish(supportTopic, new Message(CustomerSupportContent.DE));
   }
-}
+}

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

@@ -2,7 +2,6 @@
 
 /** This enum defines the content for {@link Topic} CUSTOMER_SUPPORT. */
 public enum CustomerSupportContent {
-
   DE("[email protected]"),
   AT("[email protected]");
 

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

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

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

@@ -20,4 +20,4 @@ public interface Publisher {
    * @param message message with content to be published
    */
   void publish(Topic topic, Message message);
-}
+}

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

@@ -22,7 +22,9 @@ public void onMessage(Message message) {
     if (message.content() instanceof CustomerSupportContent content) {
       logger.info("Subscriber: {} sent the email to: {}", subscriberName, content.getEmail());
     } else {
-      logger.error("Unknown content type: {} expected: {}", message.content().getClass(),
+      logger.error(
+          "Unknown content type: {} expected: {}",
+          message.content().getClass(),
           CustomerSupportContent.class);
     }
   }

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

@@ -23,7 +23,9 @@ public void onMessage(Message message) {
     if (message.content() instanceof WeatherContent content) {
       logger.info("Subscriber: {} issued message: {}", subscriberName, content.getMessage());
     } else {
-      logger.error("Unknown content type: {} expected: {}", message.content().getClass(),
+      logger.error(
+          "Unknown content type: {} expected: {}",
+          message.content().getClass(),
           CustomerSupportContent.class);
     }
   }

publish-subscribe/src/test/java/com/iluwatar/publish/subscribe/AppTest.java

@@ -8,6 +8,6 @@ public class AppTest {
 
   @Test
   void shouldExecuteApplicationWithoutException() {
-    assertDoesNotThrow(() -> App.main(new String[]{}));
+    assertDoesNotThrow(() -> App.main(new String[] {}));
   }
 }

publish-subscribe/src/test/java/com/iluwatar/publish/subscribe/LoggerExtension.java

@@ -33,7 +33,8 @@ public List<String> getMessages() {
   }
 
   public List<String> getFormattedMessages() {
-    return listAppender.list.stream().map(e -> e.getFormattedMessage())
+    return listAppender.list.stream()
+        .map(e -> e.getFormattedMessage())
         .collect(Collectors.toList());
   }
-}
+}

publish-subscribe/src/test/java/com/iluwatar/publish/subscribe/model/MessageTest.java

@@ -4,7 +4,6 @@
 
 import org.junit.jupiter.api.Test;
 
-
 public class MessageTest {
 
   @Test

publish-subscribe/src/test/java/com/iluwatar/publish/subscribe/publisher/PublisherTest.java

@@ -15,8 +15,7 @@
 
 public class PublisherTest {
 
-  @RegisterExtension
-  public LoggerExtension loggerExtension = new LoggerExtension();
+  @RegisterExtension public LoggerExtension loggerExtension = new LoggerExtension();
 
   @Test
   void testRegisterTopic() throws NoSuchFieldException, IllegalAccessException {
@@ -52,8 +51,8 @@ void testPublishUnregisteredTopic() {
     Topic topicUnregistered = new Topic(TopicName.CUSTOMER_SUPPORT);
     Message message = new Message("support");
     publisher.publish(topicUnregistered, message);
-    assertEquals("This topic is not registered: CUSTOMER_SUPPORT",
+    assertEquals(
+        "This topic is not registered: CUSTOMER_SUPPORT",
         loggerExtension.getFormattedMessages().getFirst());
-
   }
 }