codified

Facilitates objects "codification".

At the moment, the main application of this library is making it easier to encode and decode enum classes in a forward compatible way.

Installation and usage

First, make sure Maven Central is in your repositories block in Gradle build script.

repositories {
mavenCentral()
}

CodifiedEnum

Add the following dependency in order to access CodifiedEnum class.

implementation("dev.bright.codified:enums:1.9.24.1")

CodifiedEnum is a sealed class which represents either "known" or "unknown" enum type depending on the code it is represented by. For example:

enumclassFruit(overridevalcode:String) : Codified<String> {
APPLE("Apple")
}
val codifiedAppleFromEnum:CodifiedEnum<Fruit, String> =Fruit.APPLE.codifiedEnum()
val codifiedAppleFromString:CodifiedEnum<Fruit, String> ="Apple".codifiedEnum()
val codifiedCherry:CodifiedEnum<Fruit, String> ="Cherry".codifiedEnum()
Assertions.assertEquals(Fruit.APPLE, codifiedAppleFromEnum.knownOrNull())
Assertions.assertEquals(Fruit.APPLE, codifiedAppleFromString.knownOrNull())
Assertions.assertEquals(Fruit.APPLE.code, codifiedAppleFromEnum.code())
Assertions.assertEquals(Fruit.APPLE.code, codifiedAppleFromString.code())
Assertions.assertEquals(codifiedAppleFromEnum, codifiedAppleFromString)
Assertions.assertNotEquals(codifiedAppleFromEnum, codifiedCherry)
Assertions.assertEquals("Cherry", codifiedCherry.code())
when (val orange ="Orange".codifiedEnum<Fruit>()) {
isCodifiedEnum.Known->when (orange.value) {
Fruit.APPLE->TODO()
}
isCodifiedEnum.Unknown->TODO()
}

CodifiedEnum serialization

kotlinx.serialization

Add the following dependency in order to access CodifiedEnum serializer using Kotlin serialization.

implementation("dev.bright.codified:enums-serializer:1.9.24.1")

Add CodifiedSerializer object for your enum class to handle both known and unknown enum types.

enumclassFruit(overridevalcode:String) : Codified<String> {
APPLE("Apple");
object CodifiedSerializer : KSerializer<CodifiedEnum<Fruit, String>> by codifiedEnumSerializer()
}
@Serializable
data classFruitWrapper(
@Serializable(with =Fruit.CodifiedSerializer::class)
valfruit:CodifiedEnum<Fruit, String>
)
val json =Json(JsonConfiguration.Stable)
val wrapperWithApple =FruitWrapper(Fruit.APPLE.codifiedEnum())
val string = json.stringify(FruitWrapper.serializer(), wrapperWithApple)
Assertions.assertEquals("{\"fruit\":\"Apple\"}", string)
val jsonWithApple ="{\"fruit\":\"Apple\"}"val wrapperFromJsonWithApple = json.parse(FruitWrapper.serializer(), jsonWithApple)
Assertions.assertEquals(Fruit.APPLE, wrapperFromJsonWithApple.fruit.knownOrNull())
val jsonWithOrange ="{\"fruit\":\"Orange\"}"val wrapperFromJsonWithOrange = json.parse(FruitWrapper.serializer(), jsonWithOrange)
Assertions.assertEquals("Orange", wrapperFromJsonWithOrange.fruit.code())

When CodifiedEnum is a parameter of a collection such as List, @Serializable should be applied to CodifiedEnum - inside the collection type:

@Serializable
data classFoodBasket(
valfruits:List<@Serializable(with =Fruit.CodifiedSerializer::class) CodifiedEnum<Fruit, String>>,
valvegetables:List<@Serializable(with =Vegetable.CodifiedSerializer::class) CodifiedEnum<Vegetable, String>>
)

Gson

Add this dependency:

implementation("dev.bright.codified:enums-gson:1.9.24.1")

and register the TypeAdapterFactory for CodifiedEnum:

val gson =GsonBuilder()
.registerTypeAdapterFactory(CodifiedEnumTypeAdapter.Factory())
.create()