🔥 Remove Zero.Companion.orThrow(Int) function (#784)

kotools · Jan 30, 2025 · a9c6e21 · a9c6e21
1 parent 6d1de9b
commit a9c6e21
Show file tree

Hide file tree

Showing 5 changed files with 0 additions and 78 deletions.
diff --git a/subprojects/library/src/api/types.api b/subprojects/library/src/api/types.api
@@ -441,7 +441,6 @@ public final class org/kotools/types/Zero {
 	public final fun hashCode ()I
 	public static final fun orThrow (D)Lorg/kotools/types/Zero;
 	public static final fun orThrow (F)Lorg/kotools/types/Zero;
-	public static final fun orThrow (I)Lorg/kotools/types/Zero;
 	public static final fun orThrow (J)Lorg/kotools/types/Zero;
 	public static final fun orThrow (Ljava/lang/Object;)Lorg/kotools/types/Zero;
 	public static final fun orThrow (Ljava/lang/String;)Lorg/kotools/types/Zero;
@@ -465,7 +464,6 @@ public final class org/kotools/types/Zero$Companion {
 	public final synthetic fun orNull (S)Lorg/kotools/types/Zero;
 	public final fun orThrow (D)Lorg/kotools/types/Zero;
 	public final fun orThrow (F)Lorg/kotools/types/Zero;
-	public final fun orThrow (I)Lorg/kotools/types/Zero;
 	public final fun orThrow (J)Lorg/kotools/types/Zero;
 	public final fun orThrow (Ljava/lang/Object;)Lorg/kotools/types/Zero;
 	public final fun orThrow (Ljava/lang/String;)Lorg/kotools/types/Zero;

diff --git a/subprojects/library/src/commonMain/kotlin/org/kotools/types/Zero.kt b/subprojects/library/src/commonMain/kotlin/org/kotools/types/Zero.kt
@@ -715,43 +715,6 @@ public class Zero {
             null
         }
 
-        /**
-         * Creates an instance of [Zero] from the specified [number], or throws
-         * an [IllegalArgumentException] if the [number] is other than zero.
-         *
-         * <br>
-         * <details>
-         * <summary>
-         *     <b>Calling from Kotlin</b>
-         * </summary>
-         *
-         * Here's an example of calling this function from Kotlin code:
-         *
-         * SAMPLE: [org.kotools.types.ZeroCompanionCommonSample.orThrowWithInt]
-         * </details>
-         *
-         * <br>
-         * <details>
-         * <summary>
-         *     <b>Calling from Java</b>
-         * </summary>
-         *
-         * Here's an example of calling this function from Java code:
-         *
-         * SAMPLE: [org.kotools.types.ZeroCompanionJavaSample.orThrowWithInt]
-         * </details>
-         * <br>
-         *
-         * See the [orNull] function for returning `null` instead of throwing an
-         * exception in case of invalid [number].
-         */
-        @ExperimentalSince(KotoolsTypesVersion.V5_0_0)
-        @JvmStatic
-        public fun orThrow(number: Int): Zero {
-            require(number == 0) { ErrorMessage.invalidZero(number) }
-            return Zero()
-        }
-
         /**
          * Creates an instance of [Zero] from the specified [number], or throws
          * an [IllegalArgumentException] if the [number] is other than zero.

diff --git a/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionCommonSample.kt b/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionCommonSample.kt
@@ -51,17 +51,6 @@ class ZeroCompanionCommonSample {
             .forEach(::assertNotNull)
     }
 
-    @Test
-    fun orThrowWithInt() {
-        val isSuccess: Boolean = try {
-            Zero.orThrow(0)
-            true
-        } catch (exception: IllegalArgumentException) {
-            false
-        }
-        assertTrue(isSuccess)
-    }
-
     @Test
     fun orThrowWithLong() {
         val isSuccess: Boolean = try {

diff --git a/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionTest.kt b/subprojects/library/src/commonTest/kotlin/org/kotools/types/ZeroCompanionTest.kt
@@ -120,21 +120,6 @@ class ZeroCompanionTest {
             .map(Zero.Companion::orNull)
             .forEach(::assertNull)
 
-    @Test
-    fun orThrowShouldPassWithIntThatEqualsZero() {
-        val number = 0
-        Zero.orThrow(number)
-    }
-
-    @Test
-    fun orThrowShouldFailWithIntOtherThanZero() {
-        val number: Int = setOf(Int.MIN_VALUE..-1, 1..Int.MAX_VALUE)
-            .random()
-            .random()
-        assertFailsWith<IllegalArgumentException> { Zero.orThrow(number) }
-            .assertIsInvalidZero(number)
-    }
-
     @Test
     fun orThrowShouldPassWithLongThatEqualsZero() {
         val number = 0L

diff --git a/subprojects/library/src/jvmTest/java/org/kotools/types/ZeroCompanionJavaSample.java b/subprojects/library/src/jvmTest/java/org/kotools/types/ZeroCompanionJavaSample.java
@@ -7,19 +7,6 @@
 
 @SuppressWarnings("NewClassNamingConvention")
 class ZeroCompanionJavaSample {
-    @Test
-    void orThrowWithInt() {
-        final int number = 0;
-        boolean isSuccess;
-        try {
-            Zero.orThrow(number);
-            isSuccess = true;
-        } catch (final IllegalArgumentException exception) {
-            isSuccess = false;
-        }
-        Assertions.assertTrue(isSuccess);
-    }
-
     @Test
     void orThrowWithLong() {
         final long number = 0;