Skip to content

Commit dc96f35

Browse files
committed
Rename the abstract serializers
1 parent 304d175 commit dc96f35

10 files changed

+15
-15
lines changed

core/common/src/serializers/InstantSerializers.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,14 @@ public object InstantComponentSerializer : KSerializer<Instant> {
9292
* This serializer is abstract and must be subclassed to provide a concrete serializer.
9393
* Example:
9494
* ```
95-
* object Rfc1123InstantSerializer : CustomInstantSerializer(DateTimeComponents.Formats.RFC_1123)
95+
* object Rfc1123InstantSerializer : FormattedInstantSerializer(DateTimeComponents.Formats.RFC_1123)
9696
* ```
9797
*
9898
* Note that [Instant] is [kotlinx.serialization.Serializable] by default,
9999
* so it is not necessary to create custom serializers when the format is not important.
100100
* Additionally, [InstantIso8601Serializer] is provided for the ISO 8601 format.
101101
*/
102-
public abstract class CustomInstantSerializer(
102+
public abstract class FormattedInstantSerializer(
103103
private val format: DateTimeFormat<DateTimeComponents>,
104104
) : KSerializer<Instant> {
105105

core/common/src/serializers/LocalDateSerializers.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,14 @@ public object LocalDateComponentSerializer: KSerializer<LocalDate> {
8585
* This serializer is abstract and must be subclassed to provide a concrete serializer.
8686
* Example:
8787
* ```
88-
* object IsoBasicLocalDateSerializer : CustomLocalDateSerializer(LocalDate.Formats.ISO_BASIC)
88+
* object IsoBasicLocalDateSerializer : FormattedLocalDateSerializer(LocalDate.Formats.ISO_BASIC)
8989
* ```
9090
*
9191
* Note that [LocalDate] is [kotlinx.serialization.Serializable] by default,
9292
* so it is not necessary to create custom serializers when the format is not important.
9393
* Additionally, [LocalDateIso8601Serializer] is provided for the ISO 8601 format.
9494
*/
95-
public abstract class CustomLocalDateSerializer(
95+
public abstract class FormattedLocalDateSerializer(
9696
format: DateTimeFormat<LocalDate>,
9797
) : KSerializer<LocalDate> by format.asKSerializer("kotlinx.datetime.LocalDate")
9898

core/common/src/serializers/LocalDateTimeSerializers.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public object LocalDateTimeComponentSerializer: KSerializer<LocalDateTime> {
107107
* This serializer is abstract and must be subclassed to provide a concrete serializer.
108108
* Example:
109109
* ```
110-
* object PythonDateTimeSerializer : CustomLocalDateTimeSerializer(LocalDateTime.Format {
110+
* object PythonDateTimeSerializer : FormattedLocalDateTimeSerializer(LocalDateTime.Format {
111111
* date(LocalDate.Formats.ISO)
112112
* char(' ')
113113
* time(LocalTime.Formats.ISO)
@@ -118,6 +118,6 @@ public object LocalDateTimeComponentSerializer: KSerializer<LocalDateTime> {
118118
* so it is not necessary to create custom serializers when the format is not important.
119119
* Additionally, [LocalDateTimeIso8601Serializer] is provided for the ISO 8601 format.
120120
*/
121-
public abstract class CustomLocalDateTimeSerializer(
121+
public abstract class FormattedLocalDateTimeSerializer(
122122
format: DateTimeFormat<LocalDateTime>,
123123
) : KSerializer<LocalDateTime> by format.asKSerializer("kotlinx.datetime.LocalDateTime")

core/common/src/serializers/LocalTimeSerializers.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public object LocalTimeComponentSerializer : KSerializer<LocalTime> {
9090
* This serializer is abstract and must be subclassed to provide a concrete serializer.
9191
* Example:
9292
* ```
93-
* object FixedWidthTimeSerializer : CustomLocalTimeSerializer(LocalTime.Format {
93+
* object FixedWidthTimeSerializer : FormattedLocalTimeSerializer(LocalTime.Format {
9494
* hour(); char(':'); minute(); char(':'); second(); char('.'); secondFraction(3)
9595
* })
9696
* ```
@@ -99,6 +99,6 @@ public object LocalTimeComponentSerializer : KSerializer<LocalTime> {
9999
* so it is not necessary to create custom serializers when the format is not important.
100100
* Additionally, [LocalTimeIso8601Serializer] is provided for the ISO 8601 format.
101101
*/
102-
public abstract class CustomLocalTimeSerializer(
102+
public abstract class FormattedLocalTimeSerializer(
103103
format: DateTimeFormat<LocalTime>,
104104
) : KSerializer<LocalTime> by format.asKSerializer("kotlinx.datetime.LocalTime")

core/common/src/serializers/TimeZoneSerializers.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ public object UtcOffsetSerializer: KSerializer<UtcOffset> {
8181
* This serializer is abstract and must be subclassed to provide a concrete serializer.
8282
* Example:
8383
* ```
84-
* object FourDigitOffsetSerializer : CustomUtcOffsetSerializer(UtcOffset.Formats.FOUR_DIGITS)
84+
* object FourDigitOffsetSerializer : FormattedUtcOffsetSerializer(UtcOffset.Formats.FOUR_DIGITS)
8585
* ```
8686
*
8787
* Note that [UtcOffset] is [kotlinx.serialization.Serializable] by default,
8888
* so it is not necessary to create custom serializers when the format is not important.
8989
* Additionally, [UtcOffsetSerializer] is provided for the ISO 8601 format.
9090
*/
91-
public abstract class CustomUtcOffsetSerializer(
91+
public abstract class FormattedUtcOffsetSerializer(
9292
format: DateTimeFormat<UtcOffset>,
9393
) : KSerializer<UtcOffset> by format.asKSerializer("kotlinx.datetime.UtcOffset")

serialization/common/test/InstantSerializationTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class InstantSerializationTest {
6868
iso8601Serialization(Json.serializersModule.serializer())
6969
}
7070

71-
object Rfc1123InstantSerializer : CustomInstantSerializer(DateTimeComponents.Formats.RFC_1123)
71+
object Rfc1123InstantSerializer : FormattedInstantSerializer(DateTimeComponents.Formats.RFC_1123)
7272

7373
@Test
7474
fun testCustomSerializer() {

serialization/common/test/LocalDateSerializationTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class LocalDateSerializationTest {
7070
iso8601Serialization(Json.serializersModule.serializer())
7171
}
7272

73-
object IsoBasicLocalDateSerializer : CustomLocalDateSerializer(LocalDate.Formats.ISO_BASIC)
73+
object IsoBasicLocalDateSerializer : FormattedLocalDateSerializer(LocalDate.Formats.ISO_BASIC)
7474

7575
@Test
7676
fun testCustomSerializer() {

serialization/common/test/LocalDateTimeSerializationTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ class LocalDateTimeSerializationTest {
8484
iso8601Serialization(Json.serializersModule.serializer())
8585
}
8686

87-
object PythonDateTimeSerializer : CustomLocalDateTimeSerializer(LocalDateTime.Format {
87+
object PythonDateTimeSerializer : FormattedLocalDateTimeSerializer(LocalDateTime.Format {
8888
date(LocalDate.Formats.ISO)
8989
char(' ')
9090
time(LocalTime.Formats.ISO)

serialization/common/test/LocalTimeSerializationTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class LocalTimeSerializationTest {
7474
iso8601Serialization(Json.serializersModule.serializer())
7575
}
7676

77-
object FixedWidthTimeSerializer : CustomLocalTimeSerializer(LocalTime.Format {
77+
object FixedWidthTimeSerializer : FormattedLocalTimeSerializer(LocalTime.Format {
7878
hour(); char(':'); minute(); char(':'); second(); char('.'); secondFraction(3)
7979
})
8080

serialization/common/test/UtcOffsetSerializationTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class UtcOffsetSerializationTest {
3636
testSerializationAsPrimitive(UtcOffset.serializer())
3737
}
3838

39-
object FourDigitOffsetSerializer : CustomUtcOffsetSerializer(UtcOffset.Formats.FOUR_DIGITS)
39+
object FourDigitOffsetSerializer : FormattedUtcOffsetSerializer(UtcOffset.Formats.FOUR_DIGITS)
4040

4141
@Test
4242
fun testCustomSerializer() {

0 commit comments

Comments
 (0)