From c11fc78b8695d21e2a960a02e498b45a06de6b68 Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Tue, 11 Jun 2024 19:58:45 +0200
Subject: [PATCH] Add TODO ListFormatter

---
 .../sosengine/base/utility/ListFormatter.java | 79 +++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java

diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java b/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java
new file mode 100644
index 00000000..29aa8836
--- /dev/null
+++ b/base/src/main/java/de/staropensource/sosengine/base/utility/ListFormatter.java
@@ -0,0 +1,79 @@
+/*
+ * STAROPENSOURCE ENGINE SOURCE FILE
+ * Copyright (c) 2024 The StarOpenSource Engine Contributors
+ * Licensed under the GNU Affero General Public License v3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.staropensource.sosengine.base.utility;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Converts various data types to {@link String}s.
+ *
+ * @since 1-alpha0
+ */
+@SuppressWarnings({ "unused" })
+public class ListFormatter {
+    /**
+     * Converts an array to a {@link String}.
+     *
+     * @param array array to convert
+     * @return formatted string
+     */
+    @NotNull
+    public static String formatArray(@NotNull Object[] array) {
+        return Arrays.toString(array);
+    }
+
+    /**
+     * Converts a {@link Set} to a {@link String}.
+     *
+     * @param set set to convert
+     * @return formatted string
+     */
+    @NotNull
+    public static String formatSet(@NotNull Set<?> set) {
+        return set.toString();
+    }
+
+    /**
+     * Converts a {@link List} to a {@link String}.
+     *
+     * @param list list to convert
+     * @return formatted string
+     */
+    @NotNull
+    public static String formatList(@NotNull List<?> list) {
+        return list.toString();
+    }
+
+    /**
+     * Converts a {@link Map} to a {@link String}.
+     *
+     * @param map map to convert
+     * @return formatted string
+     */
+    @NotNull
+    public static String formatMap(@NotNull Map<?, ?> map) {
+        return map.toString();
+    }
+}