Merge branch 'master' into master

Author: sugan0tech

.all-contributorsrc

@@ -1548,7 +1548,8 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/17254162?v=4",
       "profile": "https://www.linkedin.com/in/souzasamuel/",
       "contributions": [
-        "code"
+        "code",
+        "doc"
       ]
     },
     {
@@ -2546,7 +2547,7 @@
       "login": "tiennm99",
       "name": "Tien Nguyen Minh",
       "avatar_url": "https://avatars.githubusercontent.com/u/39063457?v=4",
-      "profile": "http://miti99.dev",
+      "profile": "https://github.com/tiennm99",
       "contributions": [
         "code",
         "translation"
@@ -2992,7 +2993,8 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/44934142?v=4",
       "profile": "https://github.com/luismateoh",
       "contributions": [
-        "translation"
+        "translation",
+        "review"
       ]
     },
     {
@@ -3057,9 +3059,91 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "DavidMedinaO",
+      "name": "David Medina Orozco",
+      "avatar_url": "https://avatars.githubusercontent.com/u/53974843?v=4",
+      "profile": "https://github.com/DavidMedinaO",
+      "contributions": [
+        "translation",
+        "review"
+      ]
+    },
+    {
+      "login": "Romo4ka-bot",
+      "name": "Roman Leontev",
+      "avatar_url": "https://avatars.githubusercontent.com/u/61774094?v=4",
+      "profile": "https://github.com/Romo4ka-bot",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Ehspresso",
+      "name": "Riley",
+      "avatar_url": "https://avatars.githubusercontent.com/u/144370752?v=4",
+      "profile": "https://github.com/Ehspresso",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "k1w1dev",
+      "name": "k1w1dev",
+      "avatar_url": "https://avatars.githubusercontent.com/u/121696782?v=4",
+      "profile": "https://github.com/k1w1dev",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "dev-yugantar",
+      "name": "dev-yugantar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/153066190?v=4",
+      "profile": "https://github.com/dev-yugantar",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Adelechka",
+      "name": "Adelya",
+      "avatar_url": "https://avatars.githubusercontent.com/u/65678470?v=4",
+      "profile": "https://github.com/Adelechka",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "gatlanagaprasanna",
+      "name": "gatlanagaprasanna",
+      "avatar_url": "https://avatars.githubusercontent.com/u/154739216?v=4",
+      "profile": "https://github.com/gatlanagaprasanna",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Avinash2110",
+      "name": "Avinash Shukla",
+      "avatar_url": "https://avatars.githubusercontent.com/u/37360069?v=4",
+      "profile": "https://github.com/Avinash2110",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Mayankchoudhary294",
+      "name": "Mayank Choudhary",
+      "avatar_url": "https://avatars.githubusercontent.com/u/97609699?v=4",
+      "profile": "https://github.com/Mayankchoudhary294",
+      "contributions": [
+        "code"
+      ]
     }
   ],
-  "contributorsPerLine": 7,
+  "contributorsPerLine": 6,
   "projectName": "java-design-patterns",
   "projectOwner": "iluwatar",
   "repoType": "github",

.gitignore

@@ -57,3 +57,5 @@ build/
 #################### Java Design Patterns #######
 etc/Java Design Patterns.urm.puml
 serialized-entity/output.txt
+fish1.out
+fish2.out

CONTRIBUTING.MD

@@ -1,4 +1,3 @@
-This is great you have something to contribute! 
+The project guidelines can be found in [Java Design Patterns developer wiki](https://github.com/iluwatar/java-design-patterns/wiki). 
 
-Before going any further please read the [wiki](https://github.com/iluwatar/java-design-patterns/wiki)
-with conventions and rules we used for this project.
+A good place to start is: https://github.com/iluwatar/java-design-patterns/wiki/01.-How-to-contribute

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2014-2021 Ilkka Seppälä
+Copyright � 2014-2024 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

README.md

@@ -4,8 +4,11 @@ category: Structural
 language: en
 tag:
     - Abstraction
-    - Extensibility
     - Decoupling
+    - Dynamic typing
+    - Encapsulation
+    - Extensibility
+    - Polymorphism
 ---
 
 ## Intent
@@ -16,9 +19,9 @@ The Abstract Document design pattern is a structural design pattern that aims to
 
 The Abstract Document pattern enables handling additional, non-static properties. This pattern uses concept of traits to enable type safety and separate properties of different classes into set of interfaces.
 
-Real world example
+Real-world example
 
-> Consider a car that consists of multiple parts. However, we don't know if the specific car really has all the parts, or just some of them. Our cars are dynamic and extremely flexible.
+> Imagine a library system where books can have different formats and attributes: physical books, eBooks, and audiobooks. Each format has unique properties, such as page count for physical books, file size for eBooks, and duration for audiobooks. The Abstract Document design pattern allows the library system to manage these diverse formats flexibly. By using this pattern, the system can store and retrieve properties dynamically, without needing a rigid structure for each book type, making it easier to add new formats or attributes in the future without significant changes to the codebase.
 
 In plain words
 
@@ -30,6 +33,8 @@ Wikipedia says
 
 **Programmatic Example**
 
+Consider a car that consists of multiple parts. However, we don't know if the specific car really has all the parts, or just some of them. Our cars are dynamic and extremely flexible.
+
 Let's first define the base classes `Document` and `AbstractDocument`. They basically make the object hold a property map and any amount of child objects.
 
 ```java
@@ -72,7 +77,8 @@ public abstract class AbstractDocument implements Document {
                 .flatMap(Collection::stream)
                 .map(constructor);
     }
-  ...
+    
+    // Other properties and methods...
 }
 ```
 
@@ -127,47 +133,53 @@ public class Car extends AbstractDocument implements HasModel, HasPrice, HasPart
 And finally here's how we construct and use the `Car` in a full example.
 
 ```java
+  public static void main(String[] args) {
     LOGGER.info("Constructing parts and car");
 
-        var wheelProperties=Map.of(
-        Property.TYPE.toString(),"wheel",
-        Property.MODEL.toString(),"15C",
-        Property.PRICE.toString(),100L);
-
-        var doorProperties=Map.of(
-        Property.TYPE.toString(),"door",
-        Property.MODEL.toString(),"Lambo",
-        Property.PRICE.toString(),300L);
-
-        var carProperties=Map.of(
-        Property.MODEL.toString(),"300SL",
-        Property.PRICE.toString(),10000L,
-        Property.PARTS.toString(),List.of(wheelProperties,doorProperties));
-
-        var car=new Car(carProperties);
-
-        LOGGER.info("Here is our car:");
-        LOGGER.info("-> model: {}",car.getModel().orElseThrow());
-        LOGGER.info("-> price: {}",car.getPrice().orElseThrow());
-        LOGGER.info("-> parts: ");
-        car.getParts().forEach(p->LOGGER.info("\t{}/{}/{}",
-        p.getType().orElse(null),
-        p.getModel().orElse(null),
-        p.getPrice().orElse(null))
-        );
-
-// Constructing parts and car
-// Here is our car:
-// model: 300SL
-// price: 10000
-// parts: 
-// wheel/15C/100
-// door/Lambo/300
+    var wheelProperties = Map.of(
+            Property.TYPE.toString(), "wheel",
+            Property.MODEL.toString(), "15C",
+            Property.PRICE.toString(), 100L);
+
+    var doorProperties = Map.of(
+            Property.TYPE.toString(), "door",
+            Property.MODEL.toString(), "Lambo",
+            Property.PRICE.toString(), 300L);
+
+    var carProperties = Map.of(
+            Property.MODEL.toString(), "300SL",
+            Property.PRICE.toString(), 10000L,
+            Property.PARTS.toString(), List.of(wheelProperties, doorProperties));
+
+    var car = new Car(carProperties);
+
+    LOGGER.info("Here is our car:");
+    LOGGER.info("-> model: {}", car.getModel().orElseThrow());
+    LOGGER.info("-> price: {}", car.getPrice().orElseThrow());
+    LOGGER.info("-> parts: ");
+    car.getParts().forEach(p -> LOGGER.info("\t{}/{}/{}",
+            p.getType().orElse(null),
+            p.getModel().orElse(null),
+            p.getPrice().orElse(null))
+    );
+}
+```
+
+The program output:
+
+```
+07:21:57.391 [main] INFO com.iluwatar.abstractdocument.App -- Constructing parts and car
+07:21:57.393 [main] INFO com.iluwatar.abstractdocument.App -- Here is our car:
+07:21:57.393 [main] INFO com.iluwatar.abstractdocument.App -- -> model: 300SL
+07:21:57.394 [main] INFO com.iluwatar.abstractdocument.App -- -> price: 10000
+07:21:57.394 [main] INFO com.iluwatar.abstractdocument.App -- -> parts: 
+07:21:57.395 [main] INFO com.iluwatar.abstractdocument.App -- 	wheel/15C/100
+07:21:57.395 [main] INFO com.iluwatar.abstractdocument.App -- 	door/Lambo/300
 ```
 
 ## Class diagram
 
-![alt text](./etc/abstract-document.png "Abstract Document Traits and Domain")
+![Abstract Document](./etc/abstract-document.png "Abstract Document Traits and Domain")
 
 ## Applicability
 
@@ -199,7 +211,7 @@ The key idea behind the Abstract Document design pattern is to provide a flexibl
 
 ## Consequences
 
-Benefits
+Benefits:
 
 * Flexibility: Accommodates varied document structures and properties.
 
@@ -209,14 +221,17 @@ Benefits
 
 * Reusability: Typed views enable code reuse for accessing specific attribute types.
 
-Trade-offs
+Trade-offs:
 
 * Complexity: Requires defining interfaces and views, adding implementation overhead.
 
 * Performance: Might introduce slight performance overhead compared to direct data access.
 
 ## Credits
 
-* [Wikipedia: Abstract Document Pattern](https://en.wikipedia.org/wiki/Abstract_Document_Pattern)
-* [Martin Fowler: Dealing with properties](http://martinfowler.com/apsupp/properties.pdf)
+* [Design Patterns: Elements of Reusable Object-Oriented Software](https://amzn.to/3w0pvKI)
+* [Java Design Patterns: A Hands-On Experience with Real-World Examples](https://amzn.to/3yhh525)
 * [Pattern-Oriented Software Architecture Volume 4: A Pattern Language for Distributed Computing (v. 4)](https://amzn.to/49zRP4R)
+* [Patterns of Enterprise Application Architecture](https://amzn.to/3WfKBPR)
+* [Abstract Document Pattern (Wikipedia)](https://en.wikipedia.org/wiki/Abstract_Document_Pattern)
+* [Dealing with Properties (Martin Fowler)](http://martinfowler.com/apsupp/properties.pdf)