The Spotless Gradle plugin has been added

Author: javadev

.github/workflows/gradle.yml

@@ -24,4 +24,4 @@ jobs:
         java-version: '17'
         cache: 'gradle'
     - name: Build with Gradle
-      run: chmod +x gradlew && ./gradlew build
+      run: chmod +x gradlew && ./gradlew spotlessCheck build

build.gradle

@@ -1,5 +1,6 @@
 plugins {
     id 'java'
+    id 'com.diffplug.spotless' version '6.25.0'
     id 'checkstyle'
 }
 
@@ -54,3 +55,18 @@ checkstyle {
     toolVersion = '6.17'
     config = rootProject.resources.text.fromFile('fishercoder_checkstyle.xml')
 }
+
+spotless {
+    java {
+        encoding 'UTF-8'
+        target fileTree(projectDir) {
+            include '**/src/**/*.java'
+            exclude '**/build/**'
+        }
+        importOrder '\\#', '', '*'
+        removeUnusedImports()
+        googleJavaFormat('1.22.0').aosp()
+        toggleOffOn()
+        endWithNewline()
+    }
+}

src/main/java/com/fishercoder/common/classes/Employee.java

@@ -3,18 +3,13 @@
 import java.util.List;
 
 public class Employee {
-    /**
-     * It's the unique id of each node;
-     * unique id of this employee
-     */
+    /** It's the unique id of each node; unique id of this employee */
     public int id;
-    /**
-     * the importance value of this employee
-     */
+
+    /** the importance value of this employee */
     public int importance;
-    /**
-     * the id of direct subordinates
-     */
+
+    /** the id of direct subordinates */
     public List<Integer> subordinates;
 
     public Employee(int id, int importance, List<Integer> subordinates) {

src/main/java/com/fishercoder/common/classes/Interval.java

@@ -1,8 +1,6 @@
 package com.fishercoder.common.classes;
 
-/**
- * This is a class used by one OJ problem: MeetingRooms
- */
+/** This is a class used by one OJ problem: MeetingRooms */
 public class Interval implements Comparable<Interval> {
     public int start;
     public int end;
@@ -45,7 +43,7 @@ public Interval(int s, int e) {
     @Override
     public int compareTo(Interval o) {
         int compareStart = o.start;
-        //ascending order
+        // ascending order
         return this.start - compareStart;
     }
 

src/main/java/com/fishercoder/common/classes/ListNode.java

@@ -1,7 +1,6 @@
 package com.fishercoder.common.classes;
 
 import com.fishercoder.common.utils.CommonUtils;
-
 import java.util.List;
 
 /**
@@ -86,5 +85,4 @@ public int hashCode() {
     public String toString() {
         return "ListNode{" + "val=" + val + ", next=" + next + '}';
     }
-
 }

src/main/java/com/fishercoder/common/classes/NestedInteger.java

@@ -62,5 +62,4 @@ public static String printNi(NestedInteger thisNi, StringBuilder sb) {
         sb.append("]");
         return sb.toString();
     }
-
 }

src/main/java/com/fishercoder/common/classes/Node.java

@@ -22,11 +22,9 @@ public Node(int val, List<Node> children) {
         this.children = children;
     }
 
-    //todo: implement this method
+    // todo: implement this method
 
-    /**
-     * return a N-ary tree based on the preorder values
-     */
+    /** return a N-ary tree based on the preorder values */
     public static Node createNaryTree(List<Integer> preorderValues) {
         return null;
     }

src/main/java/com/fishercoder/common/classes/Point.java

@@ -1,8 +1,6 @@
 package com.fishercoder.common.classes;
 
-/**
- * Created by fishercoder on 12/31/16.
- */
+/** Created by fishercoder on 12/31/16. */
 public class Point {
     public int x;
     public int y;

src/main/java/com/fishercoder/common/classes/UndirectedGraphNode.java

@@ -3,9 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-/**
- * Created by fishercoder1534 on 9/30/16.
- */
+/** Created by fishercoder1534 on 9/30/16. */
 public class UndirectedGraphNode {
     public int val;
     public List<UndirectedGraphNode> neighbors;

src/main/java/com/fishercoder/common/utils/BTreePrinter.java

@@ -6,8 +6,8 @@
 
 /**
  * Copied this class from
- * http://stackoverflow.com/questions/4965335/how-to-print-binary-tree-diagram
- * This is an awesome one! It prints out the tree in a very nice fashion.
+ * http://stackoverflow.com/questions/4965335/how-to-print-binary-tree-diagram This is an awesome
+ * one! It prints out the tree in a very nice fashion.
  */
 public class BTreePrinter {
 
@@ -55,8 +55,7 @@ private static <T extends Comparable<?>> void printNodeInternal(
             for (int j = 0; j < nodes.size(); j++) {
                 BTreePrinter.printWhitespaces(firstSpaces - i);
                 if (nodes.get(j) == null) {
-                    BTreePrinter.printWhitespaces(endgeLines + endgeLines + i
-                            + 1);
+                    BTreePrinter.printWhitespaces(endgeLines + endgeLines + i + 1);
                     continue;
                 }
 
@@ -94,8 +93,7 @@ private static <T extends Comparable<?>> int maxLevel(Node<T> node) {
             return 0;
         }
 
-        return Math.max(BTreePrinter.maxLevel(node.left),
-                BTreePrinter.maxLevel(node.right)) + 1;
+        return Math.max(BTreePrinter.maxLevel(node.left), BTreePrinter.maxLevel(node.right)) + 1;
     }
 
     private static <T> boolean isAllElementsNull(List<T> list) {
@@ -171,7 +169,6 @@ private static Node<Integer> test2() {
         return root;
     }
 
-
     public static class Node<T extends Comparable<?>> {
         Node<T> left;
         Node<T> right;
@@ -181,5 +178,4 @@ public Node(T data) {
             this.data = data;
         }
     }
-
-}
+}

src/main/java/com/fishercoder/common/utils/CommonUtils.java

@@ -2,7 +2,6 @@
 
 import com.fishercoder.common.classes.Interval;
 import com.fishercoder.common.classes.ListNode;
-
 import java.util.ArrayList;
 import java.util.Deque;
 import java.util.List;
@@ -13,7 +12,7 @@ public class CommonUtils {
     private static final int DEFAULT_TREE_SIZE = 10;
     private static final int DEFAULT_UPPER_BOUND = 100;
 
-    //How to make a method generic: declare <T> in its method signature
+    // How to make a method generic: declare <T> in its method signature
     public static <T> void printArray_generic_type(T[] nums) {
         for (T i : nums) {
             System.out.print(i + ", ");
@@ -22,14 +21,19 @@ public static <T> void printArray_generic_type(T[] nums) {
     }
 
     public static void main(String... strings) {
-        Integer[] nums = new Integer[]{1, 2, 3, 4, 5};
+        Integer[] nums = new Integer[] {1, 2, 3, 4, 5};
         printArray_generic_type(nums);
-        String input1 = "[\"zDkA\",\"GfAj\",\"lt\"],[\"GfAj\",\"rtupD\",\"og\",\"l\"],[\"rtupD\",\"IT\",\"jGcew\",\"ZwFqF\"],[\"og\",\"yVobt\",\"EjA\",\"piUyQ\"],[\"IT\",\"XFlc\",\"W\",\"rB\"],[\"l\",\"GwQg\",\"shco\",\"Dub\",\"KwgZq\"],[\"oXMG\",\"uqe\"],[\"sNyV\",\"WbrP\"]";
+        String input1 =
+                "[\"zDkA\",\"GfAj\",\"lt\"],[\"GfAj\",\"rtupD\",\"og\",\"l\"],[\"rtupD\",\"IT\",\"jGcew\",\"ZwFqF\"],[\"og\",\"yVobt\",\"EjA\",\"piUyQ\"],[\"IT\",\"XFlc\",\"W\",\"rB\"],[\"l\",\"GwQg\",\"shco\",\"Dub\",\"KwgZq\"],[\"oXMG\",\"uqe\"],[\"sNyV\",\"WbrP\"]";
         String input2 = "[\"A\",\"B\"],[\"C\"],[\"B\",\"C\"],[\"D\"]";
         CommonUtils.printListList(convertLeetCode2DStringArrayInputIntoJavaArray(input1));
         CommonUtils.printListList(convertLeetCode2DStringArrayInputIntoJavaArray(input2));
-        CommonUtils.print(convertLeetCode1DStringArrayInputIntoJavaArray("[\"abcsi\",\"abyzjgj\",\"advz\",\"ag\",\"agkgdkob\",\"agpr\",\"ail\"]"));
-        CommonUtils.print2DIntArray(convertLeetCodeIrregularLengths2DArrayInputIntoJavaArray("[448,931,123,345],[889],[214,962],[576,746,897]"));
+        CommonUtils.print(
+                convertLeetCode1DStringArrayInputIntoJavaArray(
+                        "[\"abcsi\",\"abyzjgj\",\"advz\",\"ag\",\"agkgdkob\",\"agpr\",\"ail\"]"));
+        CommonUtils.print2DIntArray(
+                convertLeetCodeIrregularLengths2DArrayInputIntoJavaArray(
+                        "[448,931,123,345],[889],[214,962],[576,746,897]"));
     }
 
     public static void printArray(boolean[] booleans) {
@@ -98,8 +102,8 @@ public static List<Integer> randomIntArrayGenerator(int size) {
 
     // overloaded method to take no argument
     public static List<Integer> randomIntArrayGenerator() {
-        return CommonUtils.randomIntArrayGenerator(CommonUtils.DEFAULT_TREE_SIZE,
-                DEFAULT_UPPER_BOUND);
+        return CommonUtils.randomIntArrayGenerator(
+                CommonUtils.DEFAULT_TREE_SIZE, DEFAULT_UPPER_BOUND);
     }
 
     // this one has two other overloaded methods as above
@@ -126,7 +130,8 @@ public static List<Integer> uniqueIntArrayGenerator(int size) {
     }
 
     // @Notes(context =
-    // "I'm assuing only classes in this PACKAGE will call the following two methods, so just leave the modifier as default, i.e. no public, private, or protected.")
+    // "I'm assuing only classes in this PACKAGE will call the following two methods, so just leave
+    // the modifier as default, i.e. no public, private, or protected.")
     public static void printWhitespaces(int count) {
         for (int i = 0; i < count; i++) {
             System.out.print(" ");
@@ -228,7 +233,6 @@ public static void printMatrixGeneric(boolean[][] matrix) {
             System.out.println();
         }
         System.out.println("----------------------------------------------------");
-
     }
 
     public static <T> void printListList(List<List<T>> res) {
@@ -268,11 +272,13 @@ public static void print2DCharArray(char[][] arrayArrays) {
     }
 
     public static char[][] convertLeetCodeRegular2DCharArrayInputIntoJavaArray(String input) {
-/**LeetCode 2-d char array usually comes in like this:
- * ["#"," ","#"],[" "," ","#"],["#","c"," "] which is wrapped in double quotes instead of single quotes which makes it not usable in Java code.
- * This method helps with the conversion.*/
+        /**
+         * LeetCode 2-d char array usually comes in like this: ["#"," ","#"],[" ","
+         * ","#"],["#","c"," "] which is wrapped in double quotes instead of single quotes which
+         * makes it not usable in Java code. This method helps with the conversion.
+         */
         String[] arrays = input.split("],\\[");
-//        CommonUtils.printArray_generic_type(arrays);
+        //        CommonUtils.printArray_generic_type(arrays);
         int m = arrays.length;
         int n = arrays[1].split(",").length;
         char[][] ans = new char[m][n];
@@ -302,13 +308,12 @@ public static char[][] convertLeetCodeRegular2DCharArrayInputIntoJavaArray(Strin
     public static int[][] convertLeetCodeRegularRectangleArrayInputIntoJavaArray(String input) {
         /**
          * LeetCode 2-d array input usually comes like this: it's a REGULAR rectangle
-         * [[448,931],[234,889],[214,962],[576,746]]
-         * The expected input for this method is: "[448,931],[234,889],[214,962],[576,746]"
-         * i.e. strip off the beginning and ending square brackets, that's it.
-         * The output of this method will be a standard Java 2-d array.
-         * */
+         * [[448,931],[234,889],[214,962],[576,746]] The expected input for this method is:
+         * "[448,931],[234,889],[214,962],[576,746]" i.e. strip off the beginning and ending square
+         * brackets, that's it. The output of this method will be a standard Java 2-d array.
+         */
         String[] arrays = input.split("],\\[");
-//        CommonUtils.printArray_generic_type(arrays);
+        //        CommonUtils.printArray_generic_type(arrays);
         int size = arrays[1].split(",").length;
         int[][] output = new int[arrays.length][size];
         for (int i = 0; i < arrays.length; i++) {
@@ -331,18 +336,17 @@ public static int[][] convertLeetCodeRegularRectangleArrayInputIntoJavaArray(Str
                 }
             }
         }
-//        CommonUtils.print2DIntArray(output);
+        //        CommonUtils.print2DIntArray(output);
         return output;
     }
 
     public static int[][] convertLeetCodeIrregularLengths2DArrayInputIntoJavaArray(String input) {
         /**
          * LeetCode 2-d array input usually comes like this: each row could have different length
-         * [[448,931,123,345],[889],[214,962],[576,746,897]]
-         * The expected input for this method is: "[448,931,123,345],[889],[214,962],[576,746,897]"
-         * i.e. strip off the beginning and ending square brackets, that's it.
-         * The output of this method will be a standard Java 2-d array.
-         * */
+         * [[448,931,123,345],[889],[214,962],[576,746,897]] The expected input for this method is:
+         * "[448,931,123,345],[889],[214,962],[576,746,897]" i.e. strip off the beginning and ending
+         * square brackets, that's it. The output of this method will be a standard Java 2-d array.
+         */
         String[] arrays = input.split("],\\[");
         int maxLen = 0;
         int[] sizes = new int[arrays.length];
@@ -389,19 +393,17 @@ public static int[][] convertLeetCodeIrregularLengths2DArrayInputIntoJavaArray(S
 
     public static List<List<String>> convertLeetCode2DStringArrayInputIntoJavaArray(String input) {
         /**
-         * How to copy LeetCode 2-d String array into this method:
-         * 1. remove the beginning and ending quotes;
-         * 2. put double quotes into this method parameter;
-         * 3. copy the input into the double quotes.
+         * How to copy LeetCode 2-d String array into this method: 1. remove the beginning and
+         * ending quotes; 2. put double quotes into this method parameter; 3. copy the input into
+         * the double quotes.
          *
-         * LeetCode 2-d array input usually comes like this: each row could have different length
-         * [["A","B"],["C"],["B","C"],["D"]]
-         * The expected input for this method is: "[\"A\",\"B\"],[\"C\"],[\"B\",\"C\"],[\"D\"]"
-         * just copy the LeetCode input: ["A","B"],["C"],["B","C"],["D"] into double quotes in Java,
-         * it'll auto escape the double quotes.
-         * i.e. strip off the beginning and ending square brackets, that's it.
-         * The output of this method will be a standard Java 2-d array.
-         * */
+         * <p>LeetCode 2-d array input usually comes like this: each row could have different length
+         * [["A","B"],["C"],["B","C"],["D"]] The expected input for this method is:
+         * "[\"A\",\"B\"],[\"C\"],[\"B\",\"C\"],[\"D\"]" just copy the LeetCode input:
+         * ["A","B"],["C"],["B","C"],["D"] into double quotes in Java, it'll auto escape the double
+         * quotes. i.e. strip off the beginning and ending square brackets, that's it. The output of
+         * this method will be a standard Java 2-d array.
+         */
         String[] arrays = input.split("],\\[");
         List<List<String>> result = new ArrayList<>();
         for (int i = 0; i < arrays.length; i++) {
@@ -425,12 +427,10 @@ public static List<List<String>> convertLeetCode2DStringArrayInputIntoJavaArray(
     public static List<String> convertLeetCode1DStringArrayInputIntoJavaArray(String input) {
         /**
          * LeetCode 2-d array input usually comes like this: each row could have different length
-         * ["A","B","C"]
-         * The expected input for this method is: "[\"A\",\"B\",\"C\"]"
-         * just copy the LeetCode input: ["A","B","C"] into double quotes in Java,
-         * it'll auto escape the double quotes.
-         * The output of this method will be a standard Java 1-d array.
-         * */
+         * ["A","B","C"] The expected input for this method is: "[\"A\",\"B\",\"C\"]" just copy the
+         * LeetCode input: ["A","B","C"] into double quotes in Java, it'll auto escape the double
+         * quotes. The output of this method will be a standard Java 1-d array.
+         */
         String[] arrays = input.split(",");
         List<String> result = new ArrayList<>();
         for (int i = 0; i < arrays.length; i++) {

src/main/java/com/fishercoder/common/utils/LinkedListUtils.java

@@ -1,7 +1,6 @@
 package com.fishercoder.common.utils;
 
 import com.fishercoder.common.classes.ListNode;
-
 import java.util.List;
 
 public class LinkedListUtils {

src/main/java/com/fishercoder/common/utils/Notes.java

@@ -13,10 +13,10 @@
     String issue() default "";
 
     String context() default ""; // this variable is used to state how I solved
+
     // this problem, whether completely made it
     // myself, or copied it from online, or a
     // combination of both approaches.
 
     boolean needsReview() default true;
-
 }