feat: Format Byte Algorithm to String package(issue #253) (#254)

Author: saumyasharma810

README.md

@@ -2302,6 +2302,43 @@ public class KMPSubstringSearchSnippet {
 }
 ```
 
+
+### Format Bytes
+
+```java
+public class FormatBytesSnippet {
+
+    /**
+     * Convert bytes into Human readable form.
+     *
+     * @param bytes The value in bytes needed to be converted
+     * @return String the converted human-readable form
+     */
+
+    public static String formatBytes(long bytes) {
+        double kb = 1024;
+        double mb = kb * 1024;
+        double gb = mb * 1024;
+        double tb = gb * 1024;
+        if ((bytes >= 0) && (bytes < kb)) {
+            return bytes + " B";
+        } else if ((bytes >= kb) && (bytes < mb)) {
+            return String.format("%.2f KB", bytes / kb);
+        } else if ((bytes >= mb) && (bytes < gb)) {
+            return String.format("%.2f MB", bytes / mb);
+        } else if ((bytes >= gb) && (bytes < tb)) {
+            return String.format("%.2f GB", bytes / gb);
+        } else if (bytes >= tb) {
+            return String.format("%.2f TB", bytes / tb);
+        } else {
+            return "Invalid Input";
+        }
+    }
+}
+```
+
+
+
 ## Thread
 
 ### Thread Pool

src/main/java/string/FormatBytesSnippet.java

@@ -0,0 +1,58 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2017-2024 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 string;
+
+/**
+ * FormatBytesSnippet.
+ */
+
+public class FormatBytesSnippet {
+
+  /**
+   * Convert bytes into Human readable form.
+   *
+   * @param bytes The value in bytes needed to be converted
+   * @return String the converted human-readable form
+   */
+  public static String formatBytes(long bytes) {
+    double kb = 1024;
+    double mb = kb * 1024;
+    double gb = mb * 1024;
+    double tb = gb * 1024;
+    if ((bytes >= 0) && (bytes < kb)) {
+      return bytes + " B";
+    } else if ((bytes >= kb) && (bytes < mb)) {
+      return String.format("%.2f KB", bytes / kb);
+    } else if ((bytes >= mb) && (bytes < gb)) {
+      return String.format("%.2f MB", bytes / mb);
+    } else if ((bytes >= gb) && (bytes < tb)) {
+      return String.format("%.2f GB", bytes / gb);
+    } else if (bytes >= tb) {
+      return String.format("%.2f TB", bytes / tb);
+    } else {
+      return "Invalid Input";
+    }
+  }
+}

src/test/java/string/FormatBytesSnippetTest.java

@@ -0,0 +1,48 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2017-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 string;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.jupiter.api.Test;
+
+/*
+ * Tests for 30 Seconds of Java code library
+ *
+ */
+class FormatBytesSnippetTest {
+  /**
+    * * Tests for {@link FormatBytesSnippet#formatBytes(long)}.
+     */
+  @Test
+  void formatBytes() {
+    assertEquals("1.46 MB", FormatBytesSnippet.formatBytes(1536000));
+    assertEquals("4.00 GB", FormatBytesSnippet.formatBytes(4294967296L));
+    assertEquals("3.00 TB", FormatBytesSnippet.formatBytes(3L * 1024 * 1024 * 1024 * 1024));
+    assertEquals("1024.00 MB", FormatBytesSnippet.formatBytes(1024L * 1024 * 1024 - 1));
+    assertEquals("Invalid Input", FormatBytesSnippet.formatBytes(-1024));
+    assertEquals("8388608.00 TB", FormatBytesSnippet.formatBytes(Long.MAX_VALUE));
+  }
+}