Identity Field Pattern

Author: Rehab-M-Esmail

Identity_Field/src/main/java/com/iluwater/fieild/controller/BookController.java

@@ -3,25 +3,39 @@
 import com.iluwater.fieild.model.Book;
 import com.iluwater.fieild.services.BookService;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.*;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
 
+/**
+ *  Book Controller class to call the bookService methods.
+ *  */
 @RestController
 @RequestMapping("/books")
 public class BookController {
   private final BookService bookService;
 
+  /**
+   *  Constructor.
+   *  */
   @Autowired
   public BookController(BookService bookService) {
     this.bookService = bookService;
   }
-
-  // Create a new book
+  /**
+   *  Create a new book.
+   *  */
   @PostMapping
   public Book createBook(@RequestBody String title, String author) {
-    return bookService.createBook(title,author);
+    return bookService.createBook(title, author);
   }
 
-  // Get a book by ID
+  /**
+   *  Get a book by ID.
+   *  */
   @GetMapping("/{id}")
   public Book getBook(@PathVariable Long id) {
     return bookService.getBookById(id);

Identity_Field/src/main/java/com/iluwater/fieild/model/Book.java

@@ -27,14 +27,19 @@
 import javax.persistence.Entity;
 import lombok.Getter;
 import lombok.Setter;
+/**
+ * Setters & Getters.
+ */
 @Setter
 @Getter
 @Entity
 public class Book extends DomainObject {
   private String title;
   private String author;
 
-/** Book constructor*/
+  /**
+ * Book constructor.
+ */
   public Book(String title, String author) {
     this.title = title;
     this.author = author;

Identity_Field/src/main/java/com/iluwater/fieild/model/Client.java

@@ -24,19 +24,23 @@
 */
 package com.iluwater.fieild.model;
 import java.util.regex.Pattern;
-
+import javax.persistence.Entity;
 import lombok.Getter;
 import lombok.Setter;
-import javax.persistence.Entity;
 
+/**
+ * Setters & Getters.
+ */
 @Setter
 @Getter
 @Entity
 public class Client extends DomainObject {
   private static final String EMAIL_REGEX = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$";
   private String name;
   private String email;
-
+  /**
+   * Client Constructor.
+   */
   public Client(String name, String email) {
     Pattern pattern = Pattern.compile(EMAIL_REGEX);
     this.name = name;

Identity_Field/src/main/java/com/iluwater/fieild/model/DomainObject.java

@@ -38,6 +38,9 @@
 import lombok.Getter;
 import lombok.Setter;
 
+/**
+ * Setters & Getters.
+ */
 @Getter
 @Setter
 @MappedSuperclass

Identity_Field/src/main/java/com/iluwater/fieild/services/BookRepository.java

@@ -1,21 +1,30 @@
 package com.iluwater.fieild.services;
 import com.iluwater.fieild.model.Book;
-import org.springframework.stereotype.Repository;
 import javax.persistence.EntityManager;
-
+import org.springframework.stereotype.Repository;
+/**
+ * Book Repo.
+ */
 @Repository
 public class BookRepository {
   private final EntityManager entityManager;
-
+  /**
+   * BookRepository constructor.
+   */
   public BookRepository(EntityManager entityManager) {
     this.entityManager = entityManager;
   }
-
+  /**
+   * create a new book.
+   */
   public Book createBook(String title, String author) {
     Book book = new Book(title, author);
     entityManager.persist(book);
     return book;
   }
+  /**
+   *  ID Getter.
+   */
   public Book getBookById(Long id) {
     return entityManager.find(Book.class, id);
   }

Identity_Field/src/main/java/com/iluwater/fieild/services/BookService.java

@@ -1,20 +1,30 @@
 package com.iluwater.fieild.services;
-import com.iluwater.fieild.model.*;
+import com.iluwater.fieild.model.Book;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
-
+/**
+ *  Book Service Class to implement the logic.
+ */
 @Service
 public class BookService {
 
   private final BookRepository bookRepository;
-
+  /**
+   *  BookService constructor.
+   */
   @Autowired
   public BookService(BookRepository bookRepository) {
     this.bookRepository = bookRepository;
   }
-  public Book createBook(String title,String author) {
-    return bookRepository.createBook(title,author);
+  /**
+   *  Create a new book.
+   */
+  public Book createBook(String title, String author) {
+    return bookRepository.createBook(title, author);
   }
+  /**
+   *  ID Getter.
+   */
   public Book getBookById(Long id) {
     return bookRepository.getBookById(id);
   }