refactoring: Issue iluwatar#2377: The repository code has been refactored to use the recor… (iluwatar#2505)

* Issue iluwatar#2377: The repository code has been refactored to use the record class

* Issue iluwatar#2377: Refactored according to the rules defined for the repo code

* Issue iluwatar#2377: Refactored according to the rules defined for the repo code

* Issue iluwatar#2377: Refactored according to the rules defined for the repo code

Author: MugheesQasim

builder/src/main/java/com/iluwatar/builder/Hero.java

@@ -25,48 +25,13 @@
 package com.iluwatar.builder;
 
 /**
- * Hero, the class with many parameters.
+ * Hero,the record class.
  */
-public final class Hero {
 
-  private final Profession profession;
-  private final String name;
-  private final HairType hairType;
-  private final HairColor hairColor;
-  private final Armor armor;
-  private final Weapon weapon;
+public record Hero(Profession profession, String name, HairType hairType, HairColor hairColor, Armor armor, Weapon weapon) {
 
   private Hero(Builder builder) {
-    this.profession = builder.profession;
-    this.name = builder.name;
-    this.hairColor = builder.hairColor;
-    this.hairType = builder.hairType;
-    this.weapon = builder.weapon;
-    this.armor = builder.armor;
-  }
-
-  public Profession getProfession() {
-    return profession;
-  }
-
-  public String getName() {
-    return name;
-  }
-
-  public HairType getHairType() {
-    return hairType;
-  }
-
-  public HairColor getHairColor() {
-    return hairColor;
-  }
-
-  public Armor getArmor() {
-    return armor;
-  }
-
-  public Weapon getWeapon() {
-    return weapon;
+    this(builder.profession, builder.name, builder.hairType, builder.hairColor, builder.armor, builder.weapon);
   }
 
   @Override

builder/src/test/java/com/iluwatar/builder/HeroTest.java

@@ -69,12 +69,12 @@ void testBuildHero() {
 
     assertNotNull(hero);
     assertNotNull(hero.toString());
-    assertEquals(Profession.WARRIOR, hero.getProfession());
-    assertEquals(heroName, hero.getName());
-    assertEquals(Armor.CHAIN_MAIL, hero.getArmor());
-    assertEquals(Weapon.SWORD, hero.getWeapon());
-    assertEquals(HairType.LONG_CURLY, hero.getHairType());
-    assertEquals(HairColor.BLOND, hero.getHairColor());
+    assertEquals(Profession.WARRIOR, hero.profession());
+    assertEquals(heroName, hero.name());
+    assertEquals(Armor.CHAIN_MAIL, hero.armor());
+    assertEquals(Weapon.SWORD, hero.weapon());
+    assertEquals(HairType.LONG_CURLY, hero.hairType());
+    assertEquals(HairColor.BLOND, hero.hairColor());
 
   }
 

intercepting-filter/src/test/java/com/iluwatar/intercepting/filter/TargetTest.java

@@ -1,5 +1,5 @@
 /*
- * This project is licensed under the MIT license. Module intercepting-filter 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ä

model-view-presenter/src/test/java/com/iluwatar/model/view/presenter/FileSelectorJframeTest.java

@@ -1,5 +1,5 @@
 /*
- * This project is licensed under the MIT license. Module model-view-presenter 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ä

monad/src/main/java/com/iluwatar/monad/App.java

@@ -54,10 +54,10 @@ public class App {
    */
   public static void main(String[] args) {
     var user = new User("user", 24, Sex.FEMALE, "foobar.com");
-    LOGGER.info(Validator.of(user).validate(User::getName, Objects::nonNull, "name is null")
-        .validate(User::getName, name -> !name.isEmpty(), "name is empty")
-        .validate(User::getEmail, email -> !email.contains("@"), "email doesn't contains '@'")
-        .validate(User::getAge, age -> age > 20 && age < 30, "age isn't between...").get()
+    LOGGER.info(Validator.of(user).validate(User::name, Objects::nonNull, "name is null")
+        .validate(User::name, name -> !name.isEmpty(), "name is empty")
+        .validate(User::email, email -> !email.contains("@"), "email doesn't contains '@'")
+        .validate(User::age, age -> age > 20 && age < 30, "age isn't between...").get()
         .toString());
   }
 }

monad/src/main/java/com/iluwatar/monad/User.java

@@ -25,43 +25,13 @@
 package com.iluwatar.monad;
 
 /**
- * User Definition.
+ * Record class.
+ *
+ * @param name  - name
+ * @param age   - age
+ * @param sex   - sex
+ * @param email - email address
  */
-public class User {
-
-  private final String name;
-  private final int age;
-  private final Sex sex;
-  private final String email;
-
-  /**
-   * Constructor.
-   *
-   * @param name  - name
-   * @param age   - age
-   * @param sex   - sex
-   * @param email - email address
-   */
-  public User(String name, int age, Sex sex, String email) {
-    this.name = name;
-    this.age = age;
-    this.sex = sex;
-    this.email = email;
-  }
-
-  public String getName() {
-    return name;
-  }
-
-  public int getAge() {
-    return age;
-  }
-
-  public Sex getSex() {
-    return sex;
-  }
-
-  public String getEmail() {
-    return email;
-  }
+public record User(String name, int age, Sex sex, String email) {
 }
+

monad/src/test/java/com/iluwatar/monad/MonadTest.java

@@ -41,7 +41,7 @@ void testForInvalidName() {
     assertThrows(
         IllegalStateException.class,
         () -> Validator.of(tom)
-            .validate(User::getName, Objects::nonNull, "name cannot be null")
+            .validate(User::name, Objects::nonNull, "name cannot be null")
             .get()
     );
   }
@@ -52,8 +52,8 @@ void testForInvalidAge() {
     assertThrows(
         IllegalStateException.class,
         () -> Validator.of(john)
-            .validate(User::getName, Objects::nonNull, "name cannot be null")
-            .validate(User::getAge, age -> age > 21, "user is underage")
+            .validate(User::name, Objects::nonNull, "name cannot be null")
+            .validate(User::age, age -> age > 21, "user is underage")
             .get()
     );
   }
@@ -62,10 +62,10 @@ void testForInvalidAge() {
   void testForValid() {
     var sarah = new User("Sarah", 42, Sex.FEMALE, "[email protected]");
     var validated = Validator.of(sarah)
-        .validate(User::getName, Objects::nonNull, "name cannot be null")
-        .validate(User::getAge, age -> age > 21, "user is underage")
-        .validate(User::getSex, sex -> sex == Sex.FEMALE, "user is not female")
-        .validate(User::getEmail, email -> email.contains("@"), "email does not contain @ sign")
+        .validate(User::name, Objects::nonNull, "name cannot be null")
+        .validate(User::age, age -> age > 21, "user is underage")
+        .validate(User::sex, sex -> sex == Sex.FEMALE, "user is not female")
+        .validate(User::email, email -> email.contains("@"), "email does not contain @ sign")
         .get();
     assertSame(validated, sarah);
   }

null-object/src/main/java/com/iluwatar/nullobject/NodeImpl.java

@@ -29,27 +29,9 @@
 /**
  * Implementation for binary tree's normal nodes.
  */
-@Slf4j
-public class NodeImpl implements Node {
-
-  private final String name;
-  private final Node left;
-  private final Node right;
-
-  /**
-   * Constructor.
-   */
-  public NodeImpl(String name, Node left, Node right) {
-    this.name = name;
-    this.left = left;
-    this.right = right;
-  }
-
-  @Override
-  public int getTreeSize() {
-    return 1 + left.getTreeSize() + right.getTreeSize();
-  }
 
+@Slf4j
+public record NodeImpl(String name, Node left, Node right) implements Node {
   @Override
   public Node getLeft() {
     return left;
@@ -64,7 +46,10 @@ public Node getRight() {
   public String getName() {
     return name;
   }
-
+  @Override
+  public int getTreeSize() {
+    return 1 + left.getTreeSize() + right.getTreeSize();
+  }
   @Override
   public void walk() {
     LOGGER.info(name);

partial-response/src/main/java/com/iluwatar/partialresponse/Video.java

@@ -26,34 +26,10 @@
 
 /**
  * {@link Video} is a entity to serve from server.It contains all video related information.
+ * Video is a record class.
  */
-public class Video {
-  private final Integer id;
-  private final String title;
-  private final Integer length;
-  private final String description;
-  private final String director;
-  private final String language;
-
-  /**
-   * Constructor.
-   *
-   * @param id       video unique id
-   * @param title    video title
-   * @param len      video length in minutes
-   * @param desc     video description by publisher
-   * @param director video director name
-   * @param lang     video language {private, public}
-   */
-  public Video(Integer id, String title, Integer len, String desc, String director, String lang) {
-    this.id = id;
-    this.title = title;
-    this.length = len;
-    this.description = desc;
-    this.director = director;
-    this.language = lang;
-  }
 
+public record Video(Integer id, String title, Integer length, String description, String director, String language) {
   /**
    * ToString.
    *
@@ -62,12 +38,12 @@ public Video(Integer id, String title, Integer len, String desc, String director
   @Override
   public String toString() {
     return "{"
-        + "\"id\": " + id + ","
-        + "\"title\": \"" + title + "\","
-        + "\"length\": " + length + ","
-        + "\"description\": \"" + description + "\","
-        + "\"director\": \"" + director + "\","
-        + "\"language\": \"" + language + "\","
-        + "}";
+            + "\"id\": " + id + ","
+            + "\"title\": \"" + title + "\","
+            + "\"length\": " + length + ","
+            + "\"description\": \"" + description + "\","
+            + "\"director\": \"" + director + "\","
+            + "\"language\": \"" + language + "\","
+            + "}";
   }
 }

partial-response/src/main/java/com/iluwatar/partialresponse/VideoResource.java

@@ -27,24 +27,14 @@
 import java.util.Map;
 
 /**
- * The resource class which serves video information. This class act as server in the demo. Which
+ * The resource record class which serves video information. This class act as server in the demo. Which
  * has all video details.
+ *
+ * @param fieldJsonMapper map object to json.
+ * @param videos          initialize resource with existing videos. Act as database.
  */
-public class VideoResource {
-  private final FieldJsonMapper fieldJsonMapper;
-  private final Map<Integer, Video> videos;
-
-  /**
-   * Constructor.
-   *
-   * @param fieldJsonMapper map object to json.
-   * @param videos          initialize resource with existing videos. Act as database.
-   */
-  public VideoResource(FieldJsonMapper fieldJsonMapper, Map<Integer, Video> videos) {
-    this.fieldJsonMapper = fieldJsonMapper;
-    this.videos = videos;
-  }
 
+public record VideoResource(FieldJsonMapper fieldJsonMapper, Map<Integer, Video> videos) {
   /**
    * Get Details.
    *