Rename Snowflake.discordEpochStart to Snowflake.discordEpoch

kordlib · Sep 2, 2021 · 957fcc4 · 957fcc4
1 parent 95bd70e
commit 957fcc4
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 9 deletions.
diff --git a/common/src/main/kotlin/entity/Snowflake.kt b/common/src/main/kotlin/entity/Snowflake.kt
@@ -106,7 +106,18 @@ class Snowflake : Comparable<Snowflake> {
         /**
          * The point in time that marks the Discord Epoch (the first second of 2015).
          */
-        val discordEpochStart: Instant = Instant.fromEpochMilliseconds(discordEpochLong)
+        @Deprecated(
+            "Snowflake.discordEpochStart was renamed to Snowflake.discordEpoch.",
+            ReplaceWith("Snowflake.discordEpoch"),
+            DeprecationLevel.ERROR,
+        )
+        val discordEpochStart: Instant
+            get() = discordEpoch
+
+        /**
+         * The point in time that marks the Discord Epoch (the first second of 2015).
+         */
+        val discordEpoch: Instant = Instant.fromEpochMilliseconds(discordEpochLong)
 
         /**
          * The last point in time a Snowflake can represent.

diff --git a/common/src/test/kotlin/entity/SnowflakeTest.kt b/common/src/test/kotlin/entity/SnowflakeTest.kt
@@ -11,8 +11,8 @@ import kotlin.test.*
 class SnowflakeTest {
 
     @Test
-    fun `min Snowflake's timeStamp is equal to discordEpochStart`() {
-        assertEquals(Snowflake.discordEpochStart, Snowflake.min.timeStamp)
+    fun `min Snowflake's timeStamp is equal to discordEpoch`() {
+        assertEquals(Snowflake.discordEpoch, Snowflake.min.timeStamp)
     }
 
     @Test
@@ -21,9 +21,9 @@ class SnowflakeTest {
     }
 
     @Test
-    fun `Snowflake created from ULong MIN_VALUE has timeStamp equal to discordEpochStart`() {
+    fun `Snowflake created from ULong MIN_VALUE has timeStamp equal to discordEpoch`() {
         val snowflake = Snowflake(ULong.MIN_VALUE)
-        assertEquals(Snowflake.discordEpochStart, snowflake.timeStamp)
+        assertEquals(Snowflake.discordEpoch, snowflake.timeStamp)
     }
 
     @Test
@@ -33,15 +33,15 @@ class SnowflakeTest {
     }
 
     @Test
-    fun `Snowflake created from Long MIN_VALUE has timeStamp equal to discordEpochStart`() {
+    fun `Snowflake created from Long MIN_VALUE has timeStamp equal to discordEpoch`() {
         val snowflake = Snowflake(Long.MIN_VALUE)
-        assertEquals(Snowflake.discordEpochStart, snowflake.timeStamp)
+        assertEquals(Snowflake.discordEpoch, snowflake.timeStamp)
     }
 
     @Test
-    fun `Snowflake created from instant far in the past has timeStamp equal to discordEpochStart`() {
+    fun `Snowflake created from instant far in the past has timeStamp equal to discordEpoch`() {
         val snowflake = Snowflake(Instant.DISTANT_PAST)
-        assertEquals(Snowflake.discordEpochStart, snowflake.timeStamp)
+        assertEquals(Snowflake.discordEpoch, snowflake.timeStamp)
     }
 
     @Test