KFactory

KFactory is a library to auto generate simple factory classes with some annotation via ksp(Kotlin Symbol Processing).

Installation

First, add jitpack as one of the repositories in your project.

repositories {
    maven { url 'https://jitpack.io' }
}

And then apply the ksp plugin in your module where you need the factory be generated.

plugins {
    id 'com.google.devtools.ksp' version '1.7.10-1.0.6'
}

And then declare the dependency. Do noted that for the processor dependency, it requires ksp not kapt

implementation 'com.github.Jintin.KFactory:annotation:{latest-version}'
ksp 'com.github.Jintin.KFactory:processor:{latest-version}'

Lastly, the generated file will be located inside build/generated/ksp/, but your IDE might not able to identify it. In such case you can add it manually like below:

sourceSets {
    main {
        java {
            srcDir "${buildDir.absolutePath}/generated/ksp/"
        }
    }
}

Usage

First, add @AutoFactory annotation to the base class that your factory class will return.

@AutoFactory
interface Animal { // Can be abstract class too
    fun sound(): String
}

And then, add @AutoElement annotation to the actual class you want to create.

@AutoElement
class Dog : Animal {
    override fun sound() = "Dog sound"
}

@AutoElement
class Cat : Animal {
    override fun sound() = "Cat sound"
}

After successfully compile, the AnimalFactory.kt will auto-generated like below:

public enum class AnimalType {
    CAT,
    DOG,
}

public fun AnimalFactory(key: AnimalType): Animal = when (key) {
    AnimalType.CAT -> Cat()
    AnimalType.DOG -> Dog()
}

Now you can call AnimalFactory(AnimalType.CAT) to get a cat or passing AnimalType.DOG to get a dog instead.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Jintin/KFactory.

License

The module is available as open source under the terms of the MIT License.