recommended changes commited

iluwatar · Jun 6, 2024 · 3b67748 · 3b67748
1 parent b65c96c
commit 3b67748
Show file tree

Hide file tree

Showing 11 changed files with 536 additions and 8 deletions.
diff --git a/multiton/bin/README.md b/multiton/bin/README.md
@@ -0,0 +1,162 @@
+---
+title: Multiton
+category: Creational
+language: en
+tag:
+    - Decoupling
+    - Instantiation
+    - Object composition
+---
+
+## Also known as
+
+* Registry of Singletons
+
+## Intent
+
+The Multiton pattern is a variation of the Singleton design pattern that manages a map of named instances as key-value pairs.
+
+## Explanation
+
+Real-world example
+
+> A real-world example of the Multiton pattern is a printer management system in a large office. In this scenario, the office has several printers, each serving a different department. Instead of creating a new printer object every time a printing request is made, the system uses the Multiton pattern to ensure that each department has exactly one printer instance. When a printing request comes from a specific department, the system checks the registry of printer instances and retrieves the existing printer for that department. If no printer exists for that department, it creates one, registers it, and then returns it. This ensures efficient management of printer resources and prevents unnecessary creation of multiple printer instances for the same department.       
+
+In plain words
+
+> Multiton pattern ensures there are a predefined amount of instances available globally.
+
+Wikipedia says
+
+> In software engineering, the multiton pattern is a design pattern which generalizes the singleton pattern. Whereas the singleton allows only one instance of a class to be created, the multiton pattern allows for the controlled creation of multiple instances, which it manages through the use of a map.
+
+**Programmatic Example**
+
+The Nazgûl, also called ringwraiths or the Nine Riders, are Sauron's most terrible servants. By definition, there's always nine of them.
+
+`Nazgul` is the multiton class.
+
+```java
+public enum NazgulName {
+
+    KHAMUL, MURAZOR, DWAR, JI_INDUR, AKHORAHIL, HOARMURATH, ADUNAPHEL, REN, UVATHA
+}
+
+public final class Nazgul {
+
+    private static final Map<NazgulName, Nazgul> nazguls;
+
+    @Getter
+    private final NazgulName name;
+
+    static {
+        nazguls = new ConcurrentHashMap<>();
+        nazguls.put(NazgulName.KHAMUL, new Nazgul(NazgulName.KHAMUL));
+        nazguls.put(NazgulName.MURAZOR, new Nazgul(NazgulName.MURAZOR));
+        nazguls.put(NazgulName.DWAR, new Nazgul(NazgulName.DWAR));
+        nazguls.put(NazgulName.JI_INDUR, new Nazgul(NazgulName.JI_INDUR));
+        nazguls.put(NazgulName.AKHORAHIL, new Nazgul(NazgulName.AKHORAHIL));
+        nazguls.put(NazgulName.HOARMURATH, new Nazgul(NazgulName.HOARMURATH));
+        nazguls.put(NazgulName.ADUNAPHEL, new Nazgul(NazgulName.ADUNAPHEL));
+        nazguls.put(NazgulName.REN, new Nazgul(NazgulName.REN));
+        nazguls.put(NazgulName.UVATHA, new Nazgul(NazgulName.UVATHA));
+    }
+
+    private Nazgul(NazgulName name) {
+        this.name = name;
+    }
+
+    public static Nazgul getInstance(NazgulName name) {
+        return nazguls.get(name);
+    }
+}
+```
+
+And here's how we access the `Nazgul` instances.
+
+```java
+  public static void main(String[] args) {
+    // eagerly initialized multiton
+    LOGGER.info("Printing out eagerly initialized multiton contents");
+    LOGGER.info("KHAMUL={}", Nazgul.getInstance(NazgulName.KHAMUL));
+    LOGGER.info("MURAZOR={}", Nazgul.getInstance(NazgulName.MURAZOR));
+    LOGGER.info("DWAR={}", Nazgul.getInstance(NazgulName.DWAR));
+    LOGGER.info("JI_INDUR={}", Nazgul.getInstance(NazgulName.JI_INDUR));
+    LOGGER.info("AKHORAHIL={}", Nazgul.getInstance(NazgulName.AKHORAHIL));
+    LOGGER.info("HOARMURATH={}", Nazgul.getInstance(NazgulName.HOARMURATH));
+    LOGGER.info("ADUNAPHEL={}", Nazgul.getInstance(NazgulName.ADUNAPHEL));
+    LOGGER.info("REN={}", Nazgul.getInstance(NazgulName.REN));
+    LOGGER.info("UVATHA={}", Nazgul.getInstance(NazgulName.UVATHA));
+
+    // enum multiton
+    LOGGER.info("Printing out enum-based multiton contents");
+    LOGGER.info("KHAMUL={}", NazgulEnum.KHAMUL);
+    LOGGER.info("MURAZOR={}", NazgulEnum.MURAZOR);
+    LOGGER.info("DWAR={}", NazgulEnum.DWAR);
+    LOGGER.info("JI_INDUR={}", NazgulEnum.JI_INDUR);
+    LOGGER.info("AKHORAHIL={}", NazgulEnum.AKHORAHIL);
+    LOGGER.info("HOARMURATH={}", NazgulEnum.HOARMURATH);
+    LOGGER.info("ADUNAPHEL={}", NazgulEnum.ADUNAPHEL);
+    LOGGER.info("REN={}", NazgulEnum.REN);
+    LOGGER.info("UVATHA={}", NazgulEnum.UVATHA);
+}
+```
+
+Program output:
+
+```
+15:16:10.597 [main] INFO com.iluwatar.multiton.App -- Printing out eagerly initialized multiton contents
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- KHAMUL=com.iluwatar.multiton.Nazgul@4141d797
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- MURAZOR=com.iluwatar.multiton.Nazgul@38cccef
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- DWAR=com.iluwatar.multiton.Nazgul@5679c6c6
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- JI_INDUR=com.iluwatar.multiton.Nazgul@27ddd392
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- AKHORAHIL=com.iluwatar.multiton.Nazgul@19e1023e
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- HOARMURATH=com.iluwatar.multiton.Nazgul@7cef4e59
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- ADUNAPHEL=com.iluwatar.multiton.Nazgul@64b8f8f4
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- REN=com.iluwatar.multiton.Nazgul@2db0f6b2
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- UVATHA=com.iluwatar.multiton.Nazgul@3cd1f1c8
+15:16:10.600 [main] INFO com.iluwatar.multiton.App -- Printing out enum-based multiton contents
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- KHAMUL=KHAMUL
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- MURAZOR=MURAZOR
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- DWAR=DWAR
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- JI_INDUR=JI_INDUR
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- AKHORAHIL=AKHORAHIL
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- HOARMURATH=HOARMURATH
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- ADUNAPHEL=ADUNAPHEL
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- REN=REN
+15:16:10.601 [main] INFO com.iluwatar.multiton.App -- UVATHA=UVATHA
+```
+
+## Applicability
+
+Use the Multiton pattern when
+
+* A class must have named instances, but only one instance for each unique key.
+* Global access to these instances is necessary without requiring global variables.
+* You want to manage shared resources categorized by key.
+
+## Known Uses
+
+* Managing database connections in different contexts.
+* Configuration settings for different environments in an application.
+
+## Consequences
+
+Benefits:
+
+* Ensures controlled access to instances based on key.
+* Reduces global state usage by encapsulating instance management within the pattern.
+
+Trade-offs:
+
+* Increased memory usage if not managed properly due to multiple instances.
+* Potential issues with concurrency if not implemented with thread safety in mind.
+
+## Related Patterns
+
+* [Singleton](https://java-design-patterns.com/patterns/singleton/): Multiton can be seen as an extension of the Singleton pattern where Singleton allows only one instance of a class, Multiton allows one instance per key.
+* [Factory Method](https://java-design-patterns.com/patterns/factory-method/): Multiton uses a method to create or retrieve instances, similar to how a Factory Method controls object creation.
+
+## Credits
+
+* [Design Patterns: Elements of Reusable Object-Oriented Software](https://amzn.to/3w0pvKI)
diff --git a/multiton/bin/etc/multiton.png b/multiton/bin/etc/multiton.png
diff --git a/multiton/bin/etc/multiton.ucls b/multiton/bin/etc/multiton.ucls
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<class-diagram version="1.1.8" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true" 
+  realizations="true" associations="true" dependencies="false" nesting-relationships="true">  
+  <enumeration id="1" language="java" name="com.iluwatar.NazgulName" project="multiton" 
+    file="/multiton/src/main/java/com/iluwatar/NazgulName.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="232" y="516"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </enumeration>  
+  <class id="2" language="java" name="com.iluwatar.Nazgul" project="multiton" 
+    file="/multiton/src/main/java/com/iluwatar/Nazgul.java" binary="false" corner="BOTTOM_RIGHT">    
+    <position height="-1" width="-1" x="231" y="279"/>    
+    <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+      sort-features="false" accessors="true" visibility="true">      
+      <attributes public="true" package="true" protected="true" private="true" static="true"/>      
+      <operations public="true" package="true" protected="true" private="true" static="true"/>    
+    </display>  
+  </class>  
+  <association id="3">    
+    <end type="SOURCE" refId="2" navigable="false">      
+      <attribute id="4" name="name"/>      
+      <multiplicity id="5" minimum="0" maximum="1"/>    
+    </end>    
+    <end type="TARGET" refId="1" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <association id="6">    
+    <end type="SOURCE" refId="2" navigable="false">      
+      <attribute id="7" name="nazguls"/>      
+      <multiplicity id="8" minimum="0" maximum="2147483647"/>    
+    </end>    
+    <end type="TARGET" refId="2" navigable="true"/>    
+    <display labels="true" multiplicity="true"/>  
+  </association>  
+  <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
+    sort-features="false" accessors="true" visibility="true">    
+    <attributes public="true" package="true" protected="true" private="true" static="true"/>    
+    <operations public="true" package="true" protected="true" private="true" static="true"/>  
+  </classifier-display>  
+  <association-display labels="true" multiplicity="true"/>
+</class-diagram>
diff --git a/multiton/bin/etc/multiton.urm.puml b/multiton/bin/etc/multiton.urm.puml
@@ -0,0 +1,43 @@
+@startuml
+package com.iluwatar.multiton {
+  class App {
+    - LOGGER : Logger {static}
+    + App()
+    + main(args : String[]) {static}
+  }
+  class Nazgul {
+    - name : NazgulName
+    - nazguls : Map<NazgulName, Nazgul> {static}
+    - Nazgul(name : NazgulName)
+    + getInstance(name : NazgulName) : Nazgul {static}
+    + getName() : NazgulName
+  }
+  enum NazgulEnum {
+    + ADUNAPHEL {static}
+    + AKHORAHIL {static}
+    + DWAR {static}
+    + HOARMURATH {static}
+    + JI_INDUR {static}
+    + KHAMUL {static}
+    + MURAZOR {static}
+    + REN {static}
+    + UVATHA {static}
+    + valueOf(name : String) : NazgulEnum {static}
+    + values() : NazgulEnum[] {static}
+  }
+  enum NazgulName {
+    + ADUNAPHEL {static}
+    + AKHORAHIL {static}
+    + DWAR {static}
+    + HOARMURATH {static}
+    + JI_INDUR {static}
+    + KHAMUL {static}
+    + MURAZOR {static}
+    + REN {static}
+    + UVATHA {static}
+    + valueOf(name : String) : NazgulName {static}
+    + values() : NazgulName[] {static}
+  }
+}
+Nazgul -->  "-name" NazgulName
+@enduml
diff --git a/multiton/bin/pom.xml b/multiton/bin/pom.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    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.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>com.iluwatar</groupId>
+    <artifactId>java-design-patterns</artifactId>
+    <version>1.26.0-SNAPSHOT</version>
+  </parent>
+  <artifactId>multiton</artifactId>
+  <dependencies>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <executions>
+          <execution>
+            <configuration>
+              <archive>
+                <manifest>
+                  <mainClass>com.iluwatar.multiton.App</mainClass>
+                </manifest>
+              </archive>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>