From 5011fb8ae9cc568e8e969174be3e23bebbb006ff Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Sat, 29 Jun 2024 04:25:31 +0200
Subject: [PATCH] Add countOccurrences and getSeparator methods

---
 .../sosengine/base/utility/Miscellaneous.java | 49 +++++++++++++++++++
 .../srctests/EngineConfigurationTest.java     |  1 +
 2 files changed, 50 insertions(+)

diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java
index 4785c499..a1ecde2b 100644
--- a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java
+++ b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java
@@ -24,6 +24,7 @@ import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.lang.ref.WeakReference;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
@@ -114,4 +115,52 @@ public final class Miscellaneous {
             new ThrowableCatchEvent().callEvent(throwable, identifier);
         }
     }
+
+    /**
+     * Counts the occurrences of a substring inside of a string.
+     *
+     * @param string string to search
+     * @param substring substring to search for
+     * @return occurrences
+     */
+    public static long countOccurrences(@NotNull String string, @NotNull String substring) {
+        return (string.length() - string.replace(substring, "").length()) / substring.length();
+    }
+
+    /**
+     * Returns the correct separator to use when splitting a string.
+     *
+     * @param string              string to split
+     * @param separators          separators to check
+     * @param requiredOccurrences exact amount of occurrences for a separator to be deemed valid
+     * @return separator to use or {@code null}
+     * @since 1-alpha1
+     */
+    @Nullable
+    public static String getSeparator(@NotNull String string, String[] separators, int requiredOccurrences) {
+        if (string.isBlank() || separators.length == 0 || requiredOccurrences == 0)
+            return null;
+
+        for (String separator : separators)
+            if (countOccurrences(string, separator) == requiredOccurrences)
+                return separator;
+        return null;
+    }
+
+    /**
+     * Returns the correct separator to use when splitting a string.
+     *
+     * @param string             string to split
+     * @param separators         separators to check
+     * @param minimumOccurrences minimum amount of occurrences for a separator to be deemed valid
+     * @return separator to use or {@code null}
+     * @since 1-alpha1
+     */
+    @Nullable
+    public static String getSeparator(@NotNull String string, List<String> separators, Integer minimumOccurrences) {
+        for (String separator : separators)
+            if (countOccurrences(string, separator) >= minimumOccurrences)
+                return separator;
+        return null;
+    }
 }
diff --git a/base/src/test/java/de/staropensource/sosengine/base/srctests/EngineConfigurationTest.java b/base/src/test/java/de/staropensource/sosengine/base/srctests/EngineConfigurationTest.java
index 8086f651..df8225c8 100644
--- a/base/src/test/java/de/staropensource/sosengine/base/srctests/EngineConfigurationTest.java
+++ b/base/src/test/java/de/staropensource/sosengine/base/srctests/EngineConfigurationTest.java
@@ -45,6 +45,7 @@ class EngineConfigurationTest {
      * The unit logger for this instance.
      */
     private static final UnitLogger logger = new UnitLogger(EngineConfigurationTest.class);
+
     /**
      * The property group for the base engine.
      */