style: fix concurrency solutions

APICe-at-DISI · Dec 3, 2024 · 6aa7374 · 6aa7374
1 parent 0d56f40
commit 6aa7374
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 32 deletions.
diff --git a/java/concurrency/reactive-gui/src/main/java/it/unibo/oop/JFrameUtil.java b/java/concurrency/reactive-gui/src/main/java/it/unibo/oop/JFrameUtil.java
@@ -0,0 +1,29 @@
+package it.unibo.oop;
+
+import javax.swing.JFrame;
+import java.awt.Dimension;
+import java.awt.Toolkit;
+
+/**
+ * Utility class for JFrame.
+ */
+public final class JFrameUtil {
+
+    private static final double WIDTH_PERC = 0.2;
+    private static final double HEIGHT_PERC = 0.1;
+
+    private JFrameUtil() {
+    }
+
+    /**
+     * Dimensions a JFrame to a percentage of the screen size.
+     *
+     * @param target the JFrame to dimension
+     */
+    public static void dimensionJFrame(final JFrame target) {
+        final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
+        target.setSize((int) (screenSize.getWidth() * WIDTH_PERC), (int) (screenSize.getHeight() * HEIGHT_PERC));
+        target.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
+    }
+
+}
diff --git a/java/concurrency/reactive-gui/src/main/java/it/unibo/oop/reactivegui01/ConcurrentGUI.java b/java/concurrency/reactive-gui/src/main/java/it/unibo/oop/reactivegui01/ConcurrentGUI.java
@@ -1,8 +1,9 @@
 package it.unibo.oop.reactivegui01;
 
 
-import java.awt.Dimension;
-import java.awt.Toolkit;
+import it.unibo.oop.JFrameUtil;
+
+import java.io.Serial;
 import java.lang.reflect.InvocationTargetException;
 
 import javax.swing.JButton;
@@ -18,22 +19,19 @@
 @SuppressWarnings("PMD.AvoidPrintStackTrace")
 public final class ConcurrentGUI extends JFrame {
 
+    @Serial
     private static final long serialVersionUID = 1L;
-    private static final double WIDTH_PERC = 0.2;
-    private static final double HEIGHT_PERC = 0.1;
     private final JLabel display = new JLabel();
-    private final JButton stop = new JButton("stop");
 
     /**
      * Builds a new CGUI.
      */
     public ConcurrentGUI() {
         super();
-        final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
-        this.setSize((int) (screenSize.getWidth() * WIDTH_PERC), (int) (screenSize.getHeight() * HEIGHT_PERC));
-        this.setDefaultCloseOperation(EXIT_ON_CLOSE);
+        JFrameUtil.dimensionJFrame(this);
         final JPanel panel = new JPanel();
         panel.add(display);
+        final JButton stop = new JButton("stop");
         panel.add(stop);
         this.getContentPane().add(panel);
         this.setVisible(true);
@@ -54,7 +52,7 @@ public ConcurrentGUI() {
      * The counter agent is implemented as a nested class. This makes it
      * invisible outside and encapsulated.
      */
-    private class Agent implements Runnable {
+    private final class Agent implements Runnable {
         /*
          * Stop is volatile to ensure visibility. Look at:
          * 

diff --git a/java/concurrency/reactive-gui/src/main/java/it/unibo/oop/reactivegui02/ConcurrentGUI.java b/java/concurrency/reactive-gui/src/main/java/it/unibo/oop/reactivegui02/ConcurrentGUI.java
@@ -1,7 +1,8 @@
 package it.unibo.oop.reactivegui02;
 
-import java.awt.Dimension;
-import java.awt.Toolkit;
+import it.unibo.oop.JFrameUtil;
+
+import java.io.Serial;
 
 import javax.swing.JButton;
 import javax.swing.JFrame;
@@ -15,9 +16,8 @@
 @SuppressWarnings("PMD.AvoidPrintStackTrace")
 public final class ConcurrentGUI extends JFrame {
 
+    @Serial
     private static final long serialVersionUID = -6218820567019985015L;
-    private static final double WIDTH_PERC = 0.2;
-    private static final double HEIGHT_PERC = 0.1;
 
     private final JLabel display = new JLabel();
 
@@ -26,9 +26,7 @@ public final class ConcurrentGUI extends JFrame {
      */
     public ConcurrentGUI() {
         super();
-        final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
-        this.setSize((int) (screenSize.getWidth() * WIDTH_PERC), (int) (screenSize.getHeight() * HEIGHT_PERC));
-        this.setDefaultCloseOperation(EXIT_ON_CLOSE);
+        JFrameUtil.dimensionJFrame(this);
         final JPanel panel = new JPanel();
         panel.add(display);
         final JButton stop = new JButton("stop");
@@ -51,7 +49,7 @@ public ConcurrentGUI() {
         new Thread(agent).start();
     }
 
-    private class Agent implements Runnable {
+    private final class Agent implements Runnable {
         private volatile boolean stop;
         private volatile boolean up = true;
         private int counter;

diff --git a/...ncurrency/reactive-gui/src/main/java/it/unibo/oop/reactivegui03/AnotherConcurrentGUI.java b/...ncurrency/reactive-gui/src/main/java/it/unibo/oop/reactivegui03/AnotherConcurrentGUI.java
@@ -1,9 +1,11 @@
 package it.unibo.oop.reactivegui03;
 
-import java.awt.Dimension;
-import java.awt.Toolkit;
+import it.unibo.oop.JFrameUtil;
+
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.io.Serial;
+import java.io.Serializable;
 import java.lang.reflect.InvocationTargetException;
 import java.util.concurrent.TimeUnit;
 
@@ -20,8 +22,6 @@
 public final class AnotherConcurrentGUI extends JFrame {
 
     private static final long serialVersionUID = 1L;
-    private static final double WIDTH_PERC = 0.2;
-    private static final double HEIGHT_PERC = 0.1;
     private static final long WAITING_TIME = TimeUnit.SECONDS.toMillis(10);
 
     private final JLabel display = new JLabel();
@@ -35,9 +35,7 @@ public final class AnotherConcurrentGUI extends JFrame {
      * Builds a C3GUI.
      */
     public AnotherConcurrentGUI() {
-        final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
-        this.setSize((int) (screenSize.getWidth() * WIDTH_PERC), (int) (screenSize.getHeight() * HEIGHT_PERC));
-        this.setDefaultCloseOperation(EXIT_ON_CLOSE);
+        JFrameUtil.dimensionJFrame(this);
         final JPanel panel = new JPanel();
         panel.add(display);
         panel.add(up);
@@ -89,7 +87,9 @@ public void run() {
         });
     }
 
-    private class CounterAgent implements Runnable, java.io.Serializable {
+    private final class CounterAgent implements Runnable, Serializable {
+
+        @Serial
         private static final long serialVersionUID = 1L;
         private volatile boolean stop;
         private volatile boolean up = true;

diff --git a/...eactive-gui/src/main/java/it/unibo/oop/reactivegui03/AnotherConcurrentGUIWithLambdas.java b/...eactive-gui/src/main/java/it/unibo/oop/reactivegui03/AnotherConcurrentGUIWithLambdas.java
@@ -1,7 +1,9 @@
 package it.unibo.oop.reactivegui03;
 
-import java.awt.Dimension;
-import java.awt.Toolkit;
+import it.unibo.oop.JFrameUtil;
+
+import java.io.Serial;
+import java.io.Serializable;
 import java.lang.reflect.InvocationTargetException;
 import java.util.concurrent.TimeUnit;
 
@@ -17,6 +19,7 @@
 @SuppressWarnings("PMD.AvoidPrintStackTrace")
 public final class AnotherConcurrentGUIWithLambdas extends JFrame {
 
+    @Serial
     private static final long serialVersionUID = 1L;
     private static final double WIDTH_PERC = 0.2;
     private static final double HEIGHT_PERC = 0.1;
@@ -34,9 +37,7 @@ public final class AnotherConcurrentGUIWithLambdas extends JFrame {
      */
     @SuppressWarnings("CPD-START")
     public AnotherConcurrentGUIWithLambdas() {
-        final Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
-        this.setSize((int) (screenSize.getWidth() * WIDTH_PERC), (int) (screenSize.getHeight() * HEIGHT_PERC));
-        this.setDefaultCloseOperation(EXIT_ON_CLOSE);
+        JFrameUtil.dimensionJFrame(this);
         final JPanel panel = new JPanel();
         panel.add(display);
         panel.add(up);
@@ -67,7 +68,9 @@ private void stopCounting() {
         });
     }
 
-    private class CounterAgent implements Runnable, java.io.Serializable {
+    private final class CounterAgent implements Runnable, Serializable {
+
+        @Serial
         private static final long serialVersionUID = 1L;
         private volatile boolean stop;
         private volatile boolean up = true;

diff --git a/tests.main.kts b/tests.main.kts
@@ -35,7 +35,7 @@ File("java/inheritance/").inAllDirectories {
     gradle("compileJava")
 }
 
-listOf("collections", "generics", "exceptions", "lambdas", "streams").forEach {
+listOf("collections", "generics", "exceptions", "lambdas", "streams", "concurrency").forEach {
     File("java/$it").inAllDirectories {
         val tasks = arrayOf("build") + when (git.currentBranch()) {
             "exercises" -> arrayOf("-x", "test")