#3230 - Clean Architecture Sonar.

Author: Suchismita-Deb

clean-architecture/src/main/java/com/iluwatar/cleanarchitecture/App.java

@@ -1,27 +1,3 @@
-/*
- * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
- *
- * The MIT License
- * Copyright © 2014-2022 Ilkka Seppälä
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
 package com.iluwatar.cleanarchitecture;
 
 import lombok.extern.slf4j.Slf4j;
@@ -30,14 +6,16 @@
  * Clean Architecture ensures separation of concerns by organizing code,
  * into layers and making it scalable and maintainable.
  *
- * <p>In the example there are  Entities (Core Models) – Product, Cart, Order handle business logic.
- * Use Cases (Application Logic) – ShoppingCartService manages operations
- * like adding items and checkout.
- * Interfaces & Adapters – Repositories (CartRepository, OrderRepository) abstract data handling,
+ * <p>In the example there are  Entities (Core Models) – Product, Cart,
+ * Order handle business logic.
+ * Use Cases (Application Logic) – ShoppingCartService manages
+ * operations like adding items and checkout.
+ * Interfaces & Adapters – Repositories (CartRepository, OrderRepository)
+ * abstract data handling,
  * while controllers (CartController, OrderController) manage interactions.
  */
 @Slf4j
-public class App {
+public final class App {
 
   private App() {
     throw new UnsupportedOperationException("Utility class");
@@ -49,13 +27,14 @@ private App() {
    * @param args command line args
    */
   public static void main(final String[] args) {
-
     ProductRepository productRepository = new InMemoryProductRepository();
     CartRepository cartRepository = new InMemoryCartRepository();
     OrderRepository orderRepository = new InMemoryOrderRepository();
 
-    ShoppingCartService shoppingCartUseCase =
-        new ShoppingCartService(productRepository, cartRepository, orderRepository);
+    ShoppingCartService
+        shoppingCartUseCase =
+        new ShoppingCartService(
+            productRepository, cartRepository, orderRepository);
 
     CartController cartController = new CartController(shoppingCartUseCase);
     OrderController orderController = new OrderController(shoppingCartUseCase);

clean-architecture/src/main/java/com/iluwatar/cleanarchitecture/Cart.java

@@ -1,5 +1,7 @@
 /*
- * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ * This project is licensed under the MIT license.
+ * Module model-view-viewmodel is using ZK framework
+ * licensed under LGPL (see lgpl-3.0.txt).
  *
  * The MIT License
  * Copyright © 2014-2022 Ilkka Seppälä
@@ -24,27 +26,40 @@
  */
 package com.iluwatar.cleanarchitecture;
 
+import lombok.Getter;
+
 /**
- *  Cart
+ *  Cart.
  */
+@Getter
 public class Cart {
-  private Product product;
-  private int quantity;
+  /**
+   * Product.
+   */
+  private final Product product;
+
+
+  /**
+   * quantity.
+   */
+  private final int quantity;
 
-  public Cart(Product product, int quantity) {
-    this.product = product;
-    this.quantity = quantity;
+  /**
+   *
+   * @param prod
+   * @param qty
+   */
+  public Cart(final Product prod, final int qty) {
+    this.product = prod;
+    this.quantity = qty;
   }
 
+  /**
+   *
+   * @return double
+   */
   public double getTotalPrice() {
     return product.getPrice() * quantity;
   }
-  public Product getProduct() {
-    return product;
-  }
-
-  public int getQuantity() {
-    return quantity;
-  }
 
 }

clean-architecture/src/main/java/com/iluwatar/cleanarchitecture/CartController.java

@@ -1,5 +1,7 @@
 /*
- * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ * This project is licensed under the MIT license.
+ * Module model-view-viewmodel is using ZK framework
+ * licensed under LGPL (see lgpl-3.0.txt).
  *
  * The MIT License
  * Copyright © 2014-2022 Ilkka Seppälä
@@ -26,25 +28,55 @@
 package com.iluwatar.cleanarchitecture;
 
 /**
- * CartController
+ * Controller class for handling shopping cart operations.
+ *
+ * <p>This class provides methods to add, remove, and calculate the
+ * total price of items in a user's shopping cart.</p>
  */
 public class CartController {
+
+
+  /** Service layer responsible for cart operations. */
   private final ShoppingCartService shoppingCartUseCase;
 
-  public CartController(ShoppingCartService shoppingCartUseCase) {
-    this.shoppingCartUseCase = shoppingCartUseCase;
+  /**
+   * Constructs a CartController with the specified shopping cart service.
+   *
+   * @param shoppingCart The shopping cart service to handle cart operations.
+   */
+  public CartController(final ShoppingCartService shoppingCart) {
+    this.shoppingCartUseCase = shoppingCart;
   }
 
-  public void addItemToCart(String userId, String productId, int quantity) {
+  /**
+   * Adds an item to the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @param productId The ID of the product to be added.
+   * @param quantity The quantity of the product.
+   */
+  public void addItemToCart(
+      final String userId, final String productId, final int quantity) {
     shoppingCartUseCase.addItemToCart(userId, productId, quantity);
   }
 
-
-  public void removeItemFromCart(String userId, String productId) {
+  /**
+   * Removes an item from the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @param productId The ID of the product to be removed.
+   */
+  public void removeItemFromCart(final String userId, final String productId) {
     shoppingCartUseCase.removeItemFromCart(userId, productId);
   }
 
-  public double calculateTotal(String userId) {
+  /**
+   * Calculates the total cost of items in the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @return The total price of all items in the cart.
+   */
+  public double calculateTotal(final String userId) {
     return shoppingCartUseCase.calculateTotal(userId);
   }
 }

clean-architecture/src/main/java/com/iluwatar/cleanarchitecture/CartRepository.java

@@ -1,5 +1,7 @@
 /*
- * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ * This project is licensed under the MIT license.
+ * Module model-view-viewmodel is using ZK framework
+ * licensed under LGPL (see lgpl-3.0.txt).
  *
  * The MIT License
  * Copyright © 2014-2022 Ilkka Seppälä
@@ -27,12 +29,42 @@
 import java.util.List;
 
 /**
- * CartRepository
+ * CartRepository.
  */
 public interface CartRepository {
+  /**
+   * Adds an item to the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @param product The product to be added.
+   * @param quantity The quantity of the product.
+   */
   void addItemToCart(String userId, Product product, int quantity);
+  /**
+   * Removes an item from the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @param productId The ID of the product to be removed.
+   */
   void removeItemFromCart(String userId, String productId);
+  /**
+   * Retrieves the list of items in the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @return A list of items in the cart.
+   */
   List<Cart> getItemsInCart(String userId);
+  /**
+   * Calculates the total price of the items in the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @return The total price of all items in the cart.
+   */
   double calculateTotal(String userId);
+  /**
+   * Clears all items from the user's cart.
+   *
+   * @param userId The ID of the user.
+   */
   void clearCart(String userId);
 }

clean-architecture/src/main/java/com/iluwatar/cleanarchitecture/InMemoryCartRepository.java

@@ -1,5 +1,7 @@
 /*
- * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ * This project is licensed under the MIT license.
+ * Module model-view-viewmodel is using ZK framework
+ * licensed under LGPL (see lgpl-3.0.txt).
  *
  * The MIT License
  * Copyright © 2014-2022 Ilkka Seppälä
@@ -30,41 +32,78 @@
 import java.util.Map;
 
 /**
- * InMemoryCartRepository
+ * Implementation of {@link CartRepository} that stores cart items in memory.
+ *
+ * <p>This class maintains a map of user carts where each user has a
+ * list of cart items.</p>
  */
 public class InMemoryCartRepository implements CartRepository {
+  /**
+   * A map storing user carts with their respective cart items.
+   */
   private final Map<String, List<Cart>> userCarts = new HashMap<>();
 
+  /**
+   * Adds an item to the user's cart.
+   *
+   * @param userId  The ID of the user.
+   * @param product The product to be added.
+   * @param quantity The quantity of the product.
+   */
   @Override
-  public void addItemToCart(String userId, Product product, int quantity) {
+  public void addItemToCart(
+      final String userId, final Product product, final int quantity) {
     List<Cart> cart = userCarts.getOrDefault(userId, new ArrayList<>());
     cart.add(new Cart(product, quantity));
     userCarts.put(userId, cart);
   }
 
+  /**
+   * Removes an item from the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @param productId The ID of the product to be removed.
+   */
   @Override
-  public void removeItemFromCart(String userId, String productId) {
+  public void removeItemFromCart(final String userId, final String productId) {
     List<Cart> cart = userCarts.get(userId);
     if (cart != null) {
       cart.removeIf(item -> item.getProduct().getId().equals(productId));
     }
   }
 
+  /**
+   * Retrieves all items in the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @return A list of {@link Cart} items in the user's cart.
+   */
   @Override
-  public List<Cart> getItemsInCart(String userId) {
+  public List<Cart> getItemsInCart(final String userId) {
     return userCarts.getOrDefault(userId, new ArrayList<>());
   }
 
+  /**
+   * Calculates the total price of items in the user's cart.
+   *
+   * @param userId The ID of the user.
+   * @return The total price of the cart.
+   */
   @Override
-  public double calculateTotal(String userId) {
+  public double calculateTotal(final String userId) {
     return userCarts.getOrDefault(userId, new ArrayList<>())
         .stream()
         .mapToDouble(Cart::getTotalPrice)
         .sum();
   }
 
+  /**
+   * Clears all items from the user's cart.
+   *
+   * @param userId The ID of the user.
+   */
   @Override
-  public void clearCart(String userId) {
+  public void clearCart(final String userId) {
     userCarts.remove(userId);
   }
 }

clean-architecture/src/main/java/com/iluwatar/cleanarchitecture/InMemoryOrderRepository.java

@@ -1,5 +1,7 @@
 /*
- * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ * This project is licensed under the MIT license.
+ * Module model-view-viewmodel is using ZK framework
+ * licensed under LGPL (see lgpl-3.0.txt).
  *
  * The MIT License
  * Copyright © 2014-2022 Ilkka Seppälä
@@ -28,13 +30,22 @@
 import java.util.List;
 
 /**
- * InMemoryOrderRepository
+ * An in-memory implementation of the {@link OrderRepository}.
+ *
+ * <p>This class stores orders in a list, allowing orders to be saved
+ * but not persisted beyond the application's runtime.</p>
  */
 public class InMemoryOrderRepository implements OrderRepository {
+  /** A list to store orders in memory. */
   private final List<Order> orders = new ArrayList<>();
 
+  /**
+   * Saves an order to the in-memory repository.
+   *
+   * @param order The order to be saved.
+   */
   @Override
-  public void saveOrder(Order order) {
+  public void saveOrder(final Order order) {
     orders.add(order);
   }
 }