Implements flyweight

Author: LBeghini

README.md

@@ -1,91 +1,7 @@
 # ☕ Java Design Patterns
 
-## About
+## Flyweight
 
-This application is a simple Java Console Application that aims to implement design pattern examples to a Programmin Language Class. A set of design patterns will be developed
-each week, and they are divided in different [branches](https://github.com/LBeghini/Java-Design-Patterns/branches).  
+Fliweight pattern defines an object that minimizes memory use by sharing the same object in varios different locations.
 
-The main branch is just a template for every other branch.
-
-Also, to make it easier to download the source code, [releases](https://github.com/LBeghini/Java-Design-Patterns/releases) are created related to the task of the week, giving a snapshot of the code for that specific implementation.
-
-## Implemented design patterns
-
-### Behavioural patterns
-
-- [x] [Chain of responsibility](https://github.com/LBeghini/Java-Design-Patterns/tree/4-chain-of-responsibility)
-- [x] [Command](https://github.com/LBeghini/Java-Design-Patterns/tree/6-command)
-- [x] [Iterator](https://github.com/LBeghini/Java-Design-Patterns/tree/4-iterator)
-- [x] [Memento](https://github.com/LBeghini/Java-Design-Patterns/tree/5-memento)
-- [x] [Observer](https://github.com/LBeghini/Java-Design-Patterns/tree/5-observer)
-- [x] [State](https://github.com/LBeghini/Java-Design-Patterns/tree/3-state)
-- [x] [Strategy](https://github.com/LBeghini/Java-Design-Patterns/tree/6-strategy)
-- [x] [Template method](https://github.com/LBeghini/Java-Design-Patterns/tree/4-template-method)
-- [x] [Mediator](https://github.com/LBeghini/Java-Design-Patterns/tree/9-mediator)
-- [x] [Interpreter](https://github.com/LBeghini/Java-Design-Patterns/tree/9-interpreter)
-
-### Creational patterns
-
-- [ ] Abstract factory
-- [x] [Builder](https://github.com/LBeghini/Java-Design-Patterns/tree/1-builder)
-- [x] [Factory method](https://github.com/LBeghini/Java-Design-Patterns/tree/2-factory-method)
-- [x] [Prototype](https://github.com/LBeghini/Java-Design-Patterns/tree/2-prototype)
-- [x] [Singleton](https://github.com/LBeghini/Java-Design-Patterns/tree/1-singleton)
-
-### Structural patterns
-
-- [x] [Adapter](https://github.com/LBeghini/Java-Design-Patterns/tree/7-adapter)
-- [x] [Bridge](https://github.com/LBeghini/Java-Design-Patterns/tree/7-bridge)
-- [x] [Composite](https://github.com/LBeghini/Java-Design-Patterns/tree/8-composite)
-- [ ] Decorator
-- [x] [Facade](https://github.com/LBeghini/Java-Design-Patterns/tree/8-facade)
-- [ ] Flyweight
-- [ ] Proxy
-
-## Technologies
-
-- Java
-- JUnit
-- Maven
-
-## Requirements 
-
-To run and edit the project, be sure to have installed in your computer the following softwares:
-- A code editor
-
-After that, you'll need to clone this repo:
-
-```bash
-git clone https://github.com/LBeghini/Java-Design-Patterns.git
-```
-
-## Change branch
-
-To change to a different branch, run the command:
-
-```bash
-git checkout name-of-the-branch
-```
-
-The branch names have the pattern:
-
-```bash
-{number-of-the-week}-{pattern-name}
-```
-
-> `number-of-the-week` corresponds to the week asked to be implemented certain pattern 
-
-## Testing
-
-This project has no aim to run any of the implemented classes, as the goal is the code itself. However, the classes will be tested to visualize the behaviour and implementation 
-of the patterns.  
-
-You can run the tests using the maven wrapper:
-
-```bash
-./mvnw test 
-```
-
-## :balance_scale: License
-
-[MIT License](https://github.com/LBeghini/Java-Design-Patterns/blob/main/LICENSE)
+For example, when creating a characters to a game, a pre defined color is something all characters might share. You can have a character with a red hair and blue eye and yellow skin, and have another character with yellow hair, red eye and blue skin. Even in different attributes, the color is the same, and doesn't need to be kept in memory for every character you create: just create one color (let's say blue) and them for all the objects that uses this color, call the same object.

src/main/java/com/language/programming/model/Character.java

@@ -0,0 +1,22 @@
+package com.language.programming.model;
+
+public class Character {
+
+    private String name;
+    private Color hairColor;
+    private Color skinColor;
+    private Color eyeColor;
+
+    public Character(String name, String hairColor, String skinColor, String eyeColor) {
+        this.name = name;
+        this.hairColor = ColorFlyweight.getColor(hairColor);
+        this.skinColor = ColorFlyweight.getColor(skinColor);
+        this.eyeColor = ColorFlyweight.getColor(eyeColor);
+    }
+
+    public String toString() {
+        return "Character: \n" + "  name: " + this.name + "\n  hair color: " + this.hairColor + "\n  skin color: "
+                + this.skinColor + "\n  eye color: " + this.eyeColor;
+    }
+
+}

src/main/java/com/language/programming/model/Color.java

@@ -0,0 +1,19 @@
+package com.language.programming.model;
+
+public class Color {
+
+    private String name;
+
+    public Color(String name) {
+        this.name = name;
+    }
+
+    private String getColor() {
+        return this.name;
+    }
+
+    public String toString() {
+        return this.name;
+    }
+
+}

src/main/java/com/language/programming/model/ColorFlyweight.java

@@ -0,0 +1,22 @@
+package com.language.programming.model;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class ColorFlyweight {
+
+    private static Map<String, Color> colors = new HashMap<>();
+
+    public static Color getColor(String name) {
+        Color color = colors.get(name);
+        if (color == null) {
+            color = new Color(name);
+            colors.put(name, color);
+        }
+        return color;
+    }
+
+    public static int getTotalColors() {
+        return colors.size();
+    }
+}

src/test/java/com/language/programming/model/HairColorFlyweightTest.java

@@ -0,0 +1,44 @@
+package com.language.programming.model;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+
+public class HairColorFlyweightTest {
+
+    Character character1;
+    Character character2;
+    Character character3;
+    Character character4;
+
+    @BeforeAll
+    public void setUp() {
+        Character character1 = new Character("Character1", "Brown", "Red", "Purple");
+        Character character2 = new Character("Character2", "Red", "Brown", "Blue");
+        Character character3 = new Character("Character3", "Green", "Yellow", "Gray");
+        Character character4 = new Character("Character4", "Purple", "Gray", "Red");
+    }
+
+    @Test
+    public void shouldReturnCharacters() {
+
+        assertAll("CharacterList",
+                () -> Assertions.assertEquals(character1,
+                        "Character:\n name: Character1\n hair color: Brown\n skin color: Red\n eye color: Purple"),
+                () -> Assertions.assertEquals(character2,
+                        "Character:\n name: Character2\n hair color: Red\n skin color: Brown\n eye color: Blue"),
+                () -> Assertions.assertEquals(character3,
+                        "Character:\n name: Character3\n hair color: Green\n skin color: Yellow\n eye color: Gray"),
+                () -> Assertions.assertEquals(character4,
+                        "Character:\n name: Character1\n hair color: Purple\n skin color: Gray\n eye color: Red"));
+    }
+
+    @Test
+    public void shouldReturnNumberOfInputs() {
+
+        assertEquals(7, ColorFlyweight.getTotalColors());
+    }
+
+}