Add hashCode and equals in IpInterface

Author: StjepanovicSrdjan

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## NEXT
+* Add `hashCode()` and `equals` in `IpInterface` 
 
 ## 0.3.0
 * Add methods in `IpAddressAndPrefix` interface for parsing `ByteArray` representing address and subnet mask in X509 `IpAddressName`

cidre/api/android/cidre.api

@@ -210,13 +210,15 @@ public abstract class at/asitplus/cidre/IpFamily$RegexSpec {
 public abstract class at/asitplus/cidre/IpInterface : at/asitplus/cidre/IpAddressAndPrefix {
 	public static final field Companion Lat/asitplus/cidre/IpInterface$Companion;
 	public synthetic fun <init> (ILat/asitplus/cidre/IpNetwork;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun equals (Ljava/lang/Object;)Z
 	public fun getAddress ()Lat/asitplus/cidre/IpAddress;
 	public fun getFamily ()Lat/asitplus/cidre/IpFamily;
 	public fun getHostMask ()[B
 	public fun getNetmask ()[B
 	public final fun getNetwork ()Lat/asitplus/cidre/IpNetwork;
 	public fun getNumberOfHostBits-pVg5ArA ()I
 	public fun getPrefix-pVg5ArA ()I
+	public fun hashCode ()I
 	public fun isLinkLocal ()Z
 	public fun isLoopback ()Z
 	public fun isMulticast ()Z

cidre/api/cidre.klib.api

@@ -331,6 +331,8 @@ sealed class <#A: kotlin/Number, #B: at.asitplus.cidre.byteops/CidrNumber<#B>> a
     open val prefix // at.asitplus.cidre/IpInterface.prefix|{}prefix[0]
         open fun <get-prefix>(): kotlin/UInt // at.asitplus.cidre/IpInterface.prefix.<get-prefix>|<get-prefix>(){}[0]
 
+    open fun equals(kotlin/Any?): kotlin/Boolean // at.asitplus.cidre/IpInterface.equals|equals(kotlin.Any?){}[0]
+    open fun hashCode(): kotlin/Int // at.asitplus.cidre/IpInterface.hashCode|hashCode(){}[0]
     open fun toString(): kotlin/String // at.asitplus.cidre/IpInterface.toString|toString(){}[0]
     open fun toX509Octets(): kotlin/ByteArray // at.asitplus.cidre/IpInterface.toX509Octets|toX509Octets(){}[0]
 

cidre/api/jvm/cidre.api

@@ -201,13 +201,15 @@ public abstract class at/asitplus/cidre/IpFamily$RegexSpec {
 public abstract class at/asitplus/cidre/IpInterface : at/asitplus/cidre/IpAddressAndPrefix {
 	public static final field Companion Lat/asitplus/cidre/IpInterface$Companion;
 	public synthetic fun <init> (ILat/asitplus/cidre/IpNetwork;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun equals (Ljava/lang/Object;)Z
 	public fun getAddress ()Lat/asitplus/cidre/IpAddress;
 	public fun getFamily ()Lat/asitplus/cidre/IpFamily;
 	public fun getHostMask ()[B
 	public fun getNetmask ()[B
 	public final fun getNetwork ()Lat/asitplus/cidre/IpNetwork;
 	public fun getNumberOfHostBits-pVg5ArA ()I
 	public fun getPrefix-pVg5ArA ()I
+	public fun hashCode ()I
 	public fun isLinkLocal ()Z
 	public fun isLoopback ()Z
 	public fun isMulticast ()Z

cidre/src/commonMain/kotlin/at/asitplus/cidre/IpInterface.kt

@@ -13,9 +13,28 @@ constructor(override val prefix: Prefix, val network: IpNetwork<N, S>) :
     IpAddressAndPrefix<N, S> by network {
 
     override fun toString(): String = "$address/$prefix"
-
     override fun toX509Octets(): ByteArray = super.toX509Octets()
 
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (other == null || this::class != other::class) return false
+
+        other as IpInterface<*, *>
+
+        if (prefix != other.prefix) return false
+        if (network != other.network) return false
+        if (address != other.address) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        var result = prefix.hashCode()
+        result = 31 * result + network.hashCode()
+        result = 31 * result + address.hashCode()
+        return result
+    }
+
     companion object {
         @Suppress("UNCHECKED_CAST")
         internal fun <N : Number, S: CidrNumber<S>> unsafe(

cidre/src/jvmTest/kotlin/IpInterfaceEqualsTest.kt

@@ -0,0 +1,47 @@
+import at.asitplus.cidre.IpInterface
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNotEquals
+
+class IpInterfaceEqualsTest {
+
+    @Test
+    fun `IPv4 equals and hashCode`() {
+        val ip1 = IpInterface.V4("192.168.1.1/24")
+        val ip2 = IpInterface.V4("192.168.1.1/24")
+        val ip3 = IpInterface.V4("192.168.1.2/24")
+        val ip4 = IpInterface.V4("192.168.1.1/16")
+
+        assertEquals(ip1, ip2, "Should be equal")
+        assertNotEquals(ip1, ip3, "Different addresses should not be equal")
+        assertNotEquals(ip1, ip4, "Different prefixes should not be equal")
+
+        assertEquals(ip1.hashCode(), ip2.hashCode(), "Equal objects must have equal hashCodes")
+        assertNotEquals(ip1.hashCode(), ip3.hashCode(), "Should have different hashCodes")
+        assertNotEquals(ip1.hashCode(), ip4.hashCode(), "Should have different hashCodes")
+    }
+
+    @Test
+    fun `IPv6 equals and hashCode`() {
+        val ip1 = IpInterface.V6("2001:db8::1/64")
+        val ip2 = IpInterface.V6("2001:db8::1/64")
+        val ip3 = IpInterface.V6("2001:db8::2/64")
+        val ip4 = IpInterface.V6("2001:db8::1/48")
+
+        assertEquals(ip1, ip2, "Should be equal")
+        assertNotEquals(ip1, ip3, "Different addresses should not be equal")
+        assertNotEquals(ip1, ip4, "Different prefixes should not be equal")
+
+        assertEquals(ip1.hashCode(), ip2.hashCode(), "Equal objects must have equal hashCodes")
+        assertNotEquals(ip1.hashCode(), ip3.hashCode(), "Should have different hashCodes")
+        assertNotEquals(ip1.hashCode(), ip4.hashCode(), "Should have different hashCodes")
+    }
+
+    @Test
+    fun `IPv4 and IPv6 are not equal`() {
+        val ipv4 = IpInterface.V4("192.168.1.1/24")
+        val ipv6 = IpInterface.V6("2001:db8::1/64")
+
+        assertNotEquals<IpInterface<*, *>>(ipv4, ipv6, "IPv4 and IPv6 should never be equal")
+    }
+}