feature: #1261 Added collecting parameter design pattern (#2134)

* #1261 Added base directories, folders, and file for the collecting parameter design pattern. * #1261 Added initial comment * #1261 Added Maven Dependencies * #1261 Added Maven Dependencies * #1261 Finished README.md file * #1261 Added tests * #1261 Code adheres to the standard * #1261 Code adheres to the standard * #1261 Code adheres to the standard * #1261 - Added table to README.md - Explicitly state that result is the collecting parameter - Improved applicability - Separated PrinterItem.java from PrinterQueue.java - Tests work now - Giant comment split * #1261 fixed programmatic example in README.md. * #1261 updated class diagram * #1261 Fixed everything. * #1261 Minor edit to README.md. * #1261 Minor edit to README.md. * #1261 Minor updates. * #1261 Fixed code style. * #1261 Removed getPrinterQueue test * #1261 Removed code smells * #1261 Added UML plugin. * #1261 Dependencies resolved. * #1261 Specified the UML diagram paths. Perhaps this will work. * #1261 pom.xml updated with UML wrapper. Maybe this will create class diagram when built? * #1261 UML added. * #1261 - README.md obeys the YAML requirements - Typo in README.md fixed - UMLWrapper removed from module pom.xml - More comments added Should be able to merge now :)
2026-05-16 10:59:03 +00:00 · 2022-11-20 23:37:33 +11:00
parent ba5aee0a1d
commit fcaf72fdf8
12 changed files with 663 additions and 0 deletions
@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+package com.iluwatar.collectingparameter;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+
+class AppTest {
+  /**
+   * Checks whether {@link App} executes without throwing exception
+   */
+  @Test
+  void executesWithoutException() {
+    assertDoesNotThrow(() -> App.main(new String[]{}));
+  }
+}
@@ -0,0 +1,55 @@
+package com.iluwatar.collectingparameter;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.Timeout;
+
+import java.util.LinkedList;
+import java.util.Queue;
+
+class CollectingParameterTest {
+
+  @Test
+  @Timeout(1000)
+  void testCollectingParameter() {
+    PrinterQueue printerQueue = PrinterQueue.getInstance();
+    printerQueue.emptyQueue();
+
+    PrinterItem item1 = new PrinterItem(PaperSizes.A4, 1, false, true);
+    PrinterItem item2 = new PrinterItem(PaperSizes.A4, 10, true, false);
+    PrinterItem item3 = new PrinterItem(PaperSizes.A4, 4, true, true);
+    PrinterItem item4 = new PrinterItem(PaperSizes.A3, 9, false, false);
+    PrinterItem item5 = new PrinterItem(PaperSizes.A3, 3, true, true);
+    PrinterItem item6 = new PrinterItem(PaperSizes.A3, 3, false, true);
+    PrinterItem item7 = new PrinterItem(PaperSizes.A3, 3, true, false);
+    PrinterItem item8 = new PrinterItem(PaperSizes.A2, 1, false, false);
+    PrinterItem item9 = new PrinterItem(PaperSizes.A2, 2, false, false);
+    PrinterItem item10 = new PrinterItem(PaperSizes.A2, 1, true, false);
+    PrinterItem item11 = new PrinterItem(PaperSizes.A2, 1, false, true);
+
+    printerQueue.addPrinterItem(item1);
+    printerQueue.addPrinterItem(item2);
+    printerQueue.addPrinterItem(item3);
+    printerQueue.addPrinterItem(item4);
+    printerQueue.addPrinterItem(item5);
+    printerQueue.addPrinterItem(item6);
+    printerQueue.addPrinterItem(item7);
+    printerQueue.addPrinterItem(item8);
+    printerQueue.addPrinterItem(item9);
+    printerQueue.addPrinterItem(item10);
+    printerQueue.addPrinterItem(item11);
+
+    Queue<PrinterItem> result = new LinkedList<>();
+    App.addValidA4Papers(result);
+    App.addValidA3Papers(result);
+    App.addValidA2Papers(result);
+
+    Queue<PrinterItem> testResult = new LinkedList<>();
+    testResult.add(item1);
+    testResult.add(item2);
+    testResult.add(item4);
+    testResult.add(item8);
+
+    Assertions.assertArrayEquals(testResult.toArray(), result.toArray());
+  }
+}
@@ -0,0 +1,34 @@
+package com.iluwatar.collectingparameter;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.Timeout;
+
+import java.util.LinkedList;
+import java.util.Queue;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class PrinterQueueTest {
+
+  @Test
+  @Timeout(1000)
+  void singletonTest() {
+    PrinterQueue printerQueue1 = PrinterQueue.getInstance();
+    PrinterQueue printerQueue2 = PrinterQueue.getInstance();
+    assertSame(printerQueue1, printerQueue2);
+  }
+
+  @Test()
+  @Timeout(1000)
+  void negativePageCount() throws IllegalArgumentException {
+    Assertions.assertThrows(IllegalArgumentException.class, () -> new PrinterItem(PaperSizes.A4, -1, true, true));
+  }
+
+  @Test()
+  @Timeout(1000)
+  void nullPageSize() throws IllegalArgumentException {
+    Assertions.assertThrows(IllegalArgumentException.class, () -> new PrinterItem(null, 1, true, true));
+  }
+
+}