Skip to content

Commit 90c0864

Browse files
committed
Public parameters of UtcOffset type: rename to just 'offset'
1 parent 318d5c3 commit 90c0864

File tree

10 files changed

+36
-35
lines changed

10 files changed

+36
-35
lines changed

core/common/src/TimeZone.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ public expect open class TimeZone {
8686

8787
@Serializable(with = FixedOffsetTimeZoneSerializer::class)
8888
public expect class FixedOffsetTimeZone : TimeZone {
89-
public constructor(utcOffset: UtcOffset)
90-
public val utcOffset: UtcOffset
89+
public constructor(offset: UtcOffset)
90+
public val offset: UtcOffset
9191

92-
@Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
92+
@Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
9393
public val totalSeconds: Int
9494
}
9595

@@ -116,7 +116,7 @@ public expect fun TimeZone.offsetAt(instant: Instant): UtcOffset
116116
*/
117117
public expect fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime
118118

119-
internal expect fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime
119+
internal expect fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime
120120

121121

122122
/**
@@ -144,7 +144,7 @@ public fun Instant.offsetIn(timeZone: TimeZone): UtcOffset =
144144
*/
145145
public expect fun LocalDateTime.toInstant(timeZone: TimeZone): Instant
146146

147-
public expect fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant
147+
public expect fun LocalDateTime.toInstant(offset: UtcOffset): Instant
148148

149149
/**
150150
* Returns an instant that corresponds to the start of this date in the specified [timeZone].

core/common/test/TimeZoneTest.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ class TimeZoneTest {
1717
val utc: FixedOffsetTimeZone = TimeZone.UTC
1818
println(utc)
1919
assertEquals("Z", utc.id)
20-
assertEquals(0, utc.utcOffset.totalSeconds)
20+
assertEquals(0, utc.offset.totalSeconds)
21+
assertEquals(utc.offset, utc.offsetAt(Clock.System.now()))
2122
}
2223

2324
@Test

core/common/test/UtcOffsetTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,6 @@ class UtcOffsetTest {
115115
val offset = UtcOffset.parse("+01:20:30")
116116
val timeZone = offset.asTimeZone()
117117
assertIs<FixedOffsetTimeZone>(timeZone)
118-
assertEquals(offset, timeZone.utcOffset)
118+
assertEquals(offset, timeZone.offset)
119119
}
120120
}

core/darwin/src/Converters.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ public fun NSDate.toKotlinInstant(): Instant {
4343
* nearest minute.
4444
*/
4545
public fun TimeZone.toNSTimeZone(): NSTimeZone = if (this is FixedOffsetTimeZone) {
46-
require (utcOffset.totalSeconds % 60 == 0) {
46+
require (offset.totalSeconds % 60 == 0) {
4747
"NSTimeZone cannot represent fixed-offset time zones with offsets not expressed in whole minutes: $this"
4848
}
49-
NSTimeZone.timeZoneForSecondsFromGMT(utcOffset.totalSeconds.convert())
49+
NSTimeZone.timeZoneForSecondsFromGMT(offset.totalSeconds.convert())
5050
} else {
5151
NSTimeZone.timeZoneWithName(id) ?: NSTimeZone.timeZoneWithAbbreviation(id)!!
5252
}

core/darwin/test/ConvertersTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,6 @@ class ConvertersTest {
9898
val kotlinTimeZone = nsTimeZone.toKotlinTimeZone()
9999
assertEquals(hours * 3600 + minutes * 60, nsTimeZone.secondsFromGMT.convert())
100100
assertIs<FixedOffsetTimeZone>(kotlinTimeZone)
101-
assertEquals(timeZone.utcOffset, kotlinTimeZone.utcOffset)
101+
assertEquals(timeZone.offset, kotlinTimeZone.offset)
102102
}
103103
}

core/js/src/TimeZone.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ public actual open class TimeZone internal constructor(internal val zoneId: Zone
4646
}
4747

4848
@Serializable(with = FixedOffsetTimeZoneSerializer::class)
49-
public actual class FixedOffsetTimeZone actual constructor(public actual val utcOffset: UtcOffset): TimeZone(utcOffset.zoneOffset) {
49+
public actual class FixedOffsetTimeZone actual constructor(public actual val offset: UtcOffset): TimeZone(offset.zoneOffset) {
5050
private val zoneOffset get() = zoneId as jtZoneOffset
5151

52-
@Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
52+
@Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
5353
public actual val totalSeconds: Int get() = zoneOffset.totalSeconds().toInt()
5454
}
5555

@@ -61,8 +61,8 @@ public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime = t
6161
throw e
6262
}
6363

64-
internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime = try {
65-
kotlinx.datetime.internal.JSJoda.LocalDateTime.ofInstant(this.value, utcOffset.zoneOffset).let(::LocalDateTime)
64+
internal actual fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime = try {
65+
kotlinx.datetime.internal.JSJoda.LocalDateTime.ofInstant(this.value, offset.zoneOffset).let(::LocalDateTime)
6666
} catch (e: Throwable) {
6767
if (e.isJodaDateTimeException()) throw DateTimeArithmeticException(e)
6868
throw e
@@ -75,8 +75,8 @@ public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
7575
public actual fun LocalDateTime.toInstant(timeZone: TimeZone): Instant =
7676
this.value.atZone(timeZone.zoneId).toInstant().let(::Instant)
7777

78-
public actual fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant =
79-
this.value.toInstant(utcOffset.zoneOffset).let(::Instant)
78+
public actual fun LocalDateTime.toInstant(offset: UtcOffset): Instant =
79+
this.value.toInstant(offset.zoneOffset).let(::Instant)
8080

8181
public actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant =
8282
this.value.atStartOfDay(timeZone.zoneId).toInstant().let(::Instant)

core/jvm/src/Converters.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public fun java.time.ZoneId.toKotlinTimeZone(): TimeZone = TimeZone(this)
6363
/**
6464
* Converts this [kotlinx.datetime.FixedOffsetTimeZone][FixedOffsetTimeZone] value to a [java.time.ZoneOffset][java.time.ZoneOffset] value.
6565
*/
66-
public fun FixedOffsetTimeZone.toJavaZoneOffset(): java.time.ZoneOffset = this.utcOffset.zoneOffset
66+
public fun FixedOffsetTimeZone.toJavaZoneOffset(): java.time.ZoneOffset = this.offset.zoneOffset
6767

6868
/**
6969
* Converts this [java.time.ZoneOffset][java.time.ZoneOffset] value to a [kotlinx.datetime.FixedOffsetTimeZone][FixedOffsetTimeZone] value.

core/jvm/src/TimeZoneJvm.kt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ public actual open class TimeZone internal constructor(internal val zoneId: Zone
5252

5353
@Serializable(with = FixedOffsetTimeZoneSerializer::class)
5454
public actual class FixedOffsetTimeZone
55-
public actual constructor(public actual val utcOffset: UtcOffset): TimeZone(utcOffset.zoneOffset) {
56-
@Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
57-
public actual val totalSeconds: Int get() = utcOffset.totalSeconds
55+
public actual constructor(public actual val offset: UtcOffset): TimeZone(offset.zoneOffset) {
56+
@Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
57+
public actual val totalSeconds: Int get() = offset.totalSeconds
5858
}
5959

6060
public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
@@ -66,8 +66,8 @@ public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime = t
6666
throw DateTimeArithmeticException(e)
6767
}
6868

69-
internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime = try {
70-
java.time.LocalDateTime.ofInstant(this.value, utcOffset.zoneOffset).let(::LocalDateTime)
69+
internal actual fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime = try {
70+
java.time.LocalDateTime.ofInstant(this.value, offset.zoneOffset).let(::LocalDateTime)
7171
} catch (e: DateTimeException) {
7272
throw DateTimeArithmeticException(e)
7373
}
@@ -76,8 +76,8 @@ internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime
7676
public actual fun LocalDateTime.toInstant(timeZone: TimeZone): Instant =
7777
this.value.atZone(timeZone.zoneId).toInstant().let(::Instant)
7878

79-
public actual fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant =
80-
this.value.toInstant(utcOffset.zoneOffset).let(::Instant)
79+
public actual fun LocalDateTime.toInstant(offset: UtcOffset): Instant =
80+
this.value.toInstant(offset.zoneOffset).let(::Instant)
8181

8282
public actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant =
8383
this.value.atStartOfDay(timeZone.zoneId).toInstant().let(::Instant)

core/native/src/TimeZone.kt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,15 @@ public actual open class TimeZone internal constructor(internal val value: TimeZ
9393

9494

9595
@Serializable(with = FixedOffsetTimeZoneSerializer::class)
96-
public actual class FixedOffsetTimeZone internal constructor(public actual val utcOffset: UtcOffset, id: String) : TimeZone(ZoneOffsetImpl(utcOffset, id)) {
96+
public actual class FixedOffsetTimeZone internal constructor(public actual val offset: UtcOffset, id: String) : TimeZone(ZoneOffsetImpl(offset, id)) {
9797

98-
public actual constructor(utcOffset: UtcOffset) : this(utcOffset, utcOffset.toString())
98+
public actual constructor(offset: UtcOffset) : this(offset, offset.toString())
9999

100-
@Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
101-
public actual val totalSeconds: Int get() = utcOffset.totalSeconds
100+
@Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
101+
public actual val totalSeconds: Int get() = offset.totalSeconds
102102

103-
override fun instantToLocalDateTime(instant: Instant): LocalDateTime = instant.toLocalDateTime(utcOffset)
104-
override fun localDateTimeToInstant(dateTime: LocalDateTime): Instant = dateTime.toInstant(utcOffset)
103+
override fun instantToLocalDateTime(instant: Instant): LocalDateTime = instant.toLocalDateTime(offset)
104+
override fun localDateTimeToInstant(dateTime: LocalDateTime): Instant = dateTime.toInstant(offset)
105105
}
106106

107107

@@ -111,8 +111,8 @@ public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
111111
public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime =
112112
timeZone.instantToLocalDateTime(this)
113113

114-
internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime = try {
115-
toLocalDateTimeImpl(utcOffset)
114+
internal actual fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime = try {
115+
toLocalDateTimeImpl(offset)
116116
} catch (e: IllegalArgumentException) {
117117
throw DateTimeArithmeticException("Instant ${this@toLocalDateTime} is not representable as LocalDateTime", e)
118118
}
@@ -129,8 +129,8 @@ internal fun Instant.toLocalDateTimeImpl(offset: UtcOffset): LocalDateTime {
129129
public actual fun LocalDateTime.toInstant(timeZone: TimeZone): Instant =
130130
timeZone.localDateTimeToInstant(this)
131131

132-
public actual fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant =
133-
Instant(this.toEpochSecond(utcOffset), this.nanosecond)
132+
public actual fun LocalDateTime.toInstant(offset: UtcOffset): Instant =
133+
Instant(this.toEpochSecond(offset), this.nanosecond)
134134

135135
public actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant =
136136
timeZone.atStartOfDay(this)

core/native/src/ZonedDateTime.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ internal class ZonedDateTime(val dateTime: LocalDateTime, private val zone: Time
3838

3939
override fun toString(): String {
4040
var str = dateTime.toString() + offset.toString()
41-
if (zone !is FixedOffsetTimeZone || offset !== zone.utcOffset) {
41+
if (zone !is FixedOffsetTimeZone || offset !== zone.offset) {
4242
str += "[$zone]"
4343
}
4444
return str

0 commit comments

Comments
 (0)