docs: fixes for yaml frontmatter

.all-contributorsrc

@@ -1631,33 +1631,6 @@
       "contributions": [
         "translation"
       ]
-    },
-    {
-      "login": "sims-keshri",
-      "name": "Simran Keshri",
-      "avatar_url": "https://avatars.githubusercontent.com/u/62168475?v=4",
-      "profile": "https://github.com/sims-keshri",
-      "contributions": [
-        "code"
-      ]
-    },
-    {
-      "login": "JCarlosR",
-      "name": "JCarlos",
-      "avatar_url": "https://avatars.githubusercontent.com/u/3101238?v=4",
-      "profile": "https://programacionymas.com",
-      "contributions": [
-        "translation"
-      ]
-    },
-    {
-      "login": "Dev-AliGhasemi",
-      "name": "Ali Ghasemi",
-      "avatar_url": "https://avatars.githubusercontent.com/u/60359433?v=4",
-      "profile": "https://www.mrmoshkel.ir",
-      "contributions": [
-        "code"
-      ]
     }
   ],
   "contributorsPerLine": 4,

README.md

@@ -10,7 +10,7 @@
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=iluwatar_java-design-patterns&metric=coverage)](https://sonarcloud.io/dashboard?id=iluwatar_java-design-patterns)
 [![Join the chat at https://gitter.im/iluwatar/java-design-patterns](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/iluwatar/java-design-patterns?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-182-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-179-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 <br/>
@@ -343,11 +343,6 @@ This project is licensed under the terms of the MIT license.
     <td align="center"><a href="https://github.com/Conhan93"><img src="https://avatars.githubusercontent.com/u/71334757?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Conny Hansson</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=Conhan93" title="Documentation">📖</a></td>
     <td align="center"><a href="http://muklasr.medium.com"><img src="https://avatars.githubusercontent.com/u/43443753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Muklas Rahmanto</b></sub></a><br /><a href="#translation-muklasr" title="Translation">🌍</a></td>
     <td align="center"><a href="https://github.com/VxDxK"><img src="https://avatars.githubusercontent.com/u/38704817?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vadim</b></sub></a><br /><a href="#translation-VxDxK" title="Translation">🌍</a></td>
-    <td align="center"><a href="https://github.com/sims-keshri"><img src="https://avatars.githubusercontent.com/u/62168475?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Simran Keshri</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=sims-keshri" title="Code">💻</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="https://programacionymas.com"><img src="https://avatars.githubusercontent.com/u/3101238?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JCarlos</b></sub></a><br /><a href="#translation-JCarlosR" title="Translation">🌍</a></td>
-    <td align="center"><a href="https://www.mrmoshkel.ir"><img src="https://avatars.githubusercontent.com/u/60359433?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ali Ghasemi</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=Dev-AliGhasemi" title="Code">💻</a></td>
   </tr>
 </table>
 

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/App.java

@@ -59,12 +59,9 @@ import lombok.extern.slf4j.Slf4j;
 @Slf4j
 public class App {
 
-  private static final String ROCKET_LAUNCH_LOG_PATTERN = "Space rocket <%s> launched successfully";
-
   /**
    * Program entry point.
    */
-
   public static void main(String[] args) throws Exception {
     // construct a new executor that will run async tasks
     var executor = new ThreadAsyncExecutor();
@@ -90,9 +87,9 @@ public class App {
     asyncResult5.await();
 
     // log the results of the tasks, callbacks log immediately when complete
-    log(String.format(ROCKET_LAUNCH_LOG_PATTERN, result1));
+    log("Space rocket <" + result1 + "> launch complete");
-    log(String.format(ROCKET_LAUNCH_LOG_PATTERN, result2));
+    log("Space rocket <" + result2 + "> launch complete");
-    log(String.format(ROCKET_LAUNCH_LOG_PATTERN, result3));
+    log("Space rocket <" + result3 + "> launch complete");
   }
 
   /**
@@ -105,7 +102,7 @@ public class App {
   private static <T> Callable<T> lazyval(T value, long delayMillis) {
     return () -> {
       Thread.sleep(delayMillis);
-      log(String.format(ROCKET_LAUNCH_LOG_PATTERN, value));
+      log("Space rocket <" + value + "> launched successfully");
       return value;
     };
   }

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

@@ -42,14 +42,6 @@ import lombok.extern.slf4j.Slf4j;
 @Slf4j
 public class App {
 
-  private static final String LITERAL_0 = "LITERAL 0";
-  private static final String HEALTH_PATTERN = "%s_HEALTH";
-  private static final String GET_AGILITY = "GET_AGILITY";
-  private static final String GET_WISDOM = "GET_WISDOM";
-  private static final String ADD = "ADD";
-  private static final String LITERAL_2 = "LITERAL 2";
-  private static final String DIVIDE = "DIVIDE";
-
   /**
    * Main app method.
    *
@@ -61,17 +53,17 @@ public class App {
         new Wizard(45, 7, 11, 0, 0),
         new Wizard(36, 18, 8, 0, 0));
 
-    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(String.format(HEALTH_PATTERN, "GET")));
+    vm.execute(InstructionConverterUtil.convertToByteCode("GET_HEALTH"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(GET_AGILITY));
+    vm.execute(InstructionConverterUtil.convertToByteCode("GET_AGILITY"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_0));
+    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 0"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(GET_WISDOM));
+    vm.execute(InstructionConverterUtil.convertToByteCode("GET_WISDOM"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(ADD));
+    vm.execute(InstructionConverterUtil.convertToByteCode("ADD"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(LITERAL_2));
+    vm.execute(InstructionConverterUtil.convertToByteCode("LITERAL 2"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(DIVIDE));
+    vm.execute(InstructionConverterUtil.convertToByteCode("DIVIDE"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(ADD));
+    vm.execute(InstructionConverterUtil.convertToByteCode("ADD"));
-    vm.execute(InstructionConverterUtil.convertToByteCode(String.format(HEALTH_PATTERN, "SET")));
+    vm.execute(InstructionConverterUtil.convertToByteCode("SET_HEALTH"));
   }
 }

caching/src/main/java/com/iluwatar/caching/DbManager.java

@@ -50,7 +50,6 @@ public final class DbManager {
   private static boolean useMongoDB;
 
   private static Map<String, UserAccount> virtualDB;
-  private static final String ERROR_MESSAGE_LOG = "Error connecting to MongoDB";
 
   private DbManager() {
   }
@@ -86,7 +85,7 @@ public final class DbManager {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error(ERROR_MESSAGE_LOG, e);
+        LOGGER.error("Error connecting to MongoDB", e);
       }
     }
     var iterable = db
@@ -113,7 +112,7 @@ public final class DbManager {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error(ERROR_MESSAGE_LOG, e);
+        LOGGER.error("Error connecting to MongoDB", e);
       }
     }
     db.getCollection(CachingConstants.USER_ACCOUNT).insertOne(
@@ -135,7 +134,7 @@ public final class DbManager {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error(ERROR_MESSAGE_LOG, e);
+        LOGGER.error("Error connecting to MongoDB", e);
       }
     }
     db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(
@@ -156,7 +155,7 @@ public final class DbManager {
       try {
         connect();
       } catch (ParseException e) {
-        LOGGER.error(ERROR_MESSAGE_LOG, e);
+        LOGGER.error("Error connecting to MongoDB", e);
       }
     }
     db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(

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

@@ -26,9 +26,9 @@ package com.iluwatar.factory;
 import lombok.extern.slf4j.Slf4j;
 
 /**
- * Factory is an object for creating other objects. It provides a static method to 
+ * Factory is an object for creating other objects, it providing Providing a static method to 
  * create and return objects of varying classes, in order to hide the implementation logic 
- * and makes client code focus on usage rather than objects initialization and management.
+ * and makes client code focus on usage rather then objects initialization and management.
  *
  * <p>In this example an alchemist manufactures coins. CoinFactory is the factory class and it
  * provides a static method to create different types of coins.

localization/es/README.md

@@ -34,13 +34,13 @@ Todos los diseños deben ser lo más simples posible. Deberías comenzar con los
 Una vez que esté familiarizado con estos conceptos, puedes comenzar a profundizar con los
 [patrones de diseño disponibles](https://java-design-patterns.com/patterns/) por cualquiera de los siguientes enfoques
 
- - Buscar un patrón específico por su nombre. ¿No puedes encontrar uno? Informa de un nuevo patrón [aquí](https://github.com/iluwatar/java-design-patterns/issues).
+ - Buscar un patrón específico por su nombre. ¿No puedes encontrar uno? Informe un nuevo patrón [aquí](https://github.com/iluwatar/java-design-patterns/issues).
  - Usando etiquetas como `Performance`, `Gang of Four` ó `Data access`.
  - Usando categorías de patrones, `Creational`, `Behavioral` y otras.
 
-Esperamos que las soluciones orientadas a objetos presentadas en este sitio te resulten útiles en sus arquitecturas y se divierta aprendiéndolas tanto como nosotros desarrollándolas.
+Esperamos que las soluciones orientadas a objetos presentadas en este sitio le resulten útiles en sus arquitecturas y se divierta aprendiéndolas tanto como nosotros desarrollándolas.
 
-# Cómo contribuir
+# Como contribuir
 
 Si estás dispuesto a contribuir al proyecto encontrarás la información relevante en nuestra [wiki del desarrollador](https://github.com/iluwatar/java-design-patterns/wiki). Te ayudaremos y responderemos tus preguntas en la [sala de chat de Gitter](https://gitter.im/iluwatar/java-design-patterns).
 

monitor/README.md

@@ -1,71 +0,0 @@
----
-layout: pattern
-title: Monitor
-folder: monitor
-permalink: /patterns/monitor/
-categories: Concurrency
-language: en
-tags:
- - Performance
----
-
-## Intent
-Monitor pattern is used to create thread-safe objects and prevent conflicts between threads in concurrent applications.
-
-## Explanation
-
-In plain words
-
-> Monitor pattern is used to enforce single-threaded access to data. Only one thread at a time is allowed to execute code within the monitor object.
-
-Wikipedia says
-
-> In concurrent programming (also known as parallel programming), a monitor is a synchronization construct that allows threads to have both mutual exclusion and the ability to wait (block) for a certain condition to become false. Monitors also have a mechanism for signaling other threads that their condition has been met.
-
-**Programmatic Examples**
-
-Consider there is a bank that transfers money from an account to another account with transfer method . it is `synchronized` mean just one thread can access to this method because if many threads access to it and transfer money from an account to another account in same time balance changed !   
- 
-```
-class Bank {
-
-     private int[] accounts;
-     Logger logger;
- 
-     public Bank(int accountNum, int baseAmount, Logger logger) {
-         this.logger = logger;
-         accounts = new int[accountNum];
-         Arrays.fill(accounts, baseAmount);
-     }
- 
-     public synchronized void transfer(int accountA, int accountB, int amount) {
-         if (accounts[accountA] >= amount) {
-             accounts[accountB] += amount;
-             accounts[accountA] -= amount;
-             logger.info("Transferred from account :" + accountA + " to account :" + accountB + " , amount :" + amount + " . balance :" + getBalance());
-         }
-     }
-```
-
-getBalance always return total amount and the total amount should be same after each transfers 
-
-```
-     private synchronized int getBalance() {
-         int balance = 0;
-         for (int account : accounts) {
-             balance += account;
-         }
-         return balance;
-     }
- }
-```
-
-## Class diagram
-![alt text](./etc/monitor.urm.png "Monitor class diagram")
-
-## Applicability
-Use the Monitor pattern when
-
-* we have a shared resource and there is critical section .
-* you want to create thread-safe objects .
-* you want to achieve mutual exclusion in high level programming language .

monitor/etc/monitor.urm.puml

@@ -1,12 +0,0 @@
-@startuml
-Main - Bank : use
-class Main{
-    + main(args : String[]) : void
-}
-class Bank{
-    - accounts : int[]
-    + Bank (accountNum : int , baseAccount : int)
-    + transfer(accountA : int , accountB : int , amount : int) : void {synchronized}
-    - getBalance() : void {synchronized}
-}
-@enduml

monitor/pom.xml

@@ -1,59 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-    The MIT License
-    Copyright © 2014-2021 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>
-        <artifactId>java-design-patterns</artifactId>
-        <groupId>com.iluwatar</groupId>
-        <version>1.24.0-SNAPSHOT</version>
-    </parent>
-    <artifactId>monitor</artifactId>
-    <dependencies>
-        <dependency>
-            <groupId>org.junit.jupiter</groupId>
-            <artifactId>junit-jupiter-engine</artifactId>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
-    <build>
-        <plugins>
-            <!-- Maven assembly plugin is invoked with default setting which we have
-                in parent pom and specifying the class having main method -->
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-assembly-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <configuration>
-                            <archive>
-                                <manifest>
-                                    <mainClass>com.iluwatar.abstractdocument.Main</mainClass>
-                                </manifest>
-                            </archive>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-        </plugins>
-    </build>
-</project>

monitor/src/main/java/com/iluwatar/monitor/Bank.java

@@ -1,37 +0,0 @@
-package com.iluwatar.monitor;
-
-import java.util.Arrays;
-import java.util.logging.Logger;
-
-// Bank class implements the Monitor pattern
-public class Bank {
-
-    private int[] accounts;
-    Logger logger;
-
-    public Bank(int accountNum, int baseAmount, Logger logger) {
-        this.logger = logger;
-        accounts = new int[accountNum];
-        Arrays.fill(accounts, baseAmount);
-    }
-
-    public synchronized void transfer(int accountA, int accountB, int amount) {
-        if (accounts[accountA] >= amount) {
-            accounts[accountB] += amount;
-            accounts[accountA] -= amount;
-            logger.info("Transferred from account :" + accountA + " to account :" + accountB + " , amount :" + amount + " . balance :" + getBalance());
-        }
-    }
-
-    public synchronized int getBalance() {
-        int balance = 0;
-        for (int account : accounts) {
-            balance += account;
-        }
-        return balance;
-    }
-
-    public int[] getAccounts() {
-        return accounts;
-    }
-}

monitor/src/main/java/com/iluwatar/monitor/Main.java

@@ -1,60 +0,0 @@
-/*
- * The MIT License
- * Copyright © 2014-2021 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.
- */
-
-package com.iluwatar.monitor;
-
-import java.util.*;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-import java.util.logging.Logger;
-
-/**
- * <p>The Monitor pattern is used in concurrent algorithms to achieve mutual exclusion.</p>
- *
- * <p>Bank is a simple class that transfers money from an account to another account using
- * {@link Bank#transfer}. It can also return the balance of the bank account stored in the bank.</p>
- *
- * <p>Main class uses ThreadPool to run threads that do transactions on the bank accounts.</p>
- */
-
-public class Main {
-
-    public static void main(String[] args) {
-        Logger logger = Logger.getLogger("monitor");
-        var bank = new Bank(4, 1000, logger);
-        Runnable runnable = () -> {
-            try {
-                Thread.sleep((long) (Math.random() * 1000));
-                Random random = new Random();
-                for (int i = 0; i < 1000000; i++)
-                    bank.transfer(random.nextInt(4), random.nextInt(4), (int) (Math.random() * 1000));
-            } catch (InterruptedException e) {
-                logger.info(e.getMessage());
-            }
-        };
-        ExecutorService executorService = Executors.newFixedThreadPool(5);
-        for (int i = 0; i < 5; i++) {
-            executorService.execute(runnable);
-        }
-    }
-}

monitor/src/main/test/java/com/iluwater/java/BankTest.java

@@ -1,55 +0,0 @@
-package com.iluwater.java;
-
-import com.iluwatar.monitor.Bank;
-import org.junit.jupiter.api.AfterAll;
-import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Test;
-
-import static org.junit.jupiter.api.Assertions.*;
-import static org.junit.jupiter.api.Assumptions.*;
-
-import java.util.logging.Logger;
-
-public class BankTest {
-
-    private static Bank bank;
-    private static final int ACCOUNT_NUM = 4;
-    private static final int BASE_AMOUNT = 1000;
-    private static final Logger LOGGER = Logger.getLogger("monitor");
-
-    @BeforeAll
-    public static void Setup() {
-        bank = new Bank(ACCOUNT_NUM, BASE_AMOUNT, LOGGER);
-    }
-
-    @Test
-    public void GetAccountHaveNotBeNull() {
-        assertNotNull(bank.getAccounts());
-    }
-
-    @Test
-    public void LengthOfAccountsHaveToEqualsToAccountNumConstant() {
-        assumeTrue(bank.getAccounts() != null);
-        assertEquals(ACCOUNT_NUM, bank.getAccounts().length);
-    }
-
-    @Test
-    public void TransferMethodHaveToTransferAmountFromAnAccountToOtherAccount() {
-        bank.transfer(0, 1, 1000);
-        int accounts[] = bank.getAccounts();
-        assertEquals(0, accounts[0]);
-        assertEquals(2000, 2000);
-    }
-
-    @Test
-    public void BalanceHaveToBeOK() {
-        assertEquals(4000, bank.getBalance());
-    }
-
-
-    @AfterAll
-    public static void TearDown() {
-        bank = null;
-    }
-
-}