How do I use Kotlin object by reflection

Question

Let's say I need to set property A given by a String in Kotlin object O given by a String by reflection. If O was a class I could do something like this (disregard it has no sense):

fun setValue(ownerClassName: String, fieldName: String, value : Any) {
    val enclosingClass = Class.forName(ownerClassName).newInstance()
    val enclosingClassField = enclosingClass.javaClass.getDeclaredField(fieldName)
    enclosingClassField.isAccessible = true
    enclosingClassField.set(enclosingClass, value)
}

But how would I do it if O is an object?

To clarify, are you asking how to do this when you're passing in an existing object instance (say o: Any) rather than ownerClassName: String? — Oliver Charlesworth
– Oliver Charlesworth, Commented Dec 6, 2017 at 13:20

Salem · Accepted Answer · 2018-10-03 15:13:11Z

27

KClass has an objectInstance field:

Class.forName(ownerClassName).kotlin.objectInstance

This is built into Kotlin reflection.

Returns: The instance of the object declaration, or null if this class is not an object declaration.

This would be even nicer if KClass had a forName method, but sadly it does not (yet), so we need to instead get the (Java) Class and convert it to KClass.

You can get a KClass instance from a Class by using the .kotlin extension property.

Then you can continue with the rest of your code. I converted this to Kotlin's reflection library:

val kClass = Class.forName(ownerClassName).kotlin
// Get the object OR a new instance if it doesn't exist
val instance = kClass.objectInstance ?: kClass.java.newInstance()

val member = kClass.memberProperties
// Has to be a mutable property, otherwise we can't set it
        .filterIsInstance<KMutableProperty<*>>()
// Check the name
        .filter { it.name == fieldName }
        .firstOrNull()

// Set the property
member?.setter?.call(instance, value)

Here is a working test:

object TestObject {
    var field = 3
}

fun setValue(ownerClassName: String, fieldName: String, value: Any) {
    val kClass = Class.forName(ownerClassName).kotlin
    val instance = kClass.objectInstance ?: kClass.java.newInstance()

    val member = kClass.memberProperties.filterIsInstance<KMutableProperty<*>>()
            .firstOrNull { it.name == fieldName }

    member?.setter?.call(instance, value)
}

fun main(args: Array<String>) {
    println(TestObject.field) // 3
    setValue("some.package.TestObject", "field", 4)
    println(TestObject.field) // 4
}

edited Oct 3, 2018 at 15:13

answered Dec 6, 2017 at 13:17

Salem

15.2k4 gold badges58 silver badges73 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

Oliver Charlesworth Over a year ago

What do you do once you have this?

Salem Over a year ago

It seems OP is wondering what the alternative to newInstance would be for an object (singleton), since you can't make a new instance. At least that's how I interpreted it. Then you would continue setting the field by using the rest of the code in the question

Oliver Charlesworth Over a year ago

Ok, I think I interpreted the question differently (hence the downvote which I now retracted) - I assumed the OP meant an arbitrary object, rather than a Kotlin singleton object.

ssuukk Over a year ago

Actualy the question was about Kotlin singleton created by "object" keyword as opposed to "class" keyword.

ssuukk Over a year ago

Well, Aleksiej was first and his answer seems straightforward. And it does what was required.

|

Salem · Accepted Answer · 2017-12-06 14:50:52Z

13

object is translated into a class with a private constructor and a static field called INSTANCE where the only instance is stored when this class is loaded, so replacing Class.forName(ownerClassName).newInstance() with

Class.forName(ownerClassName).getDeclaredField("INSTANCE").get(null)

should work.

Javadoc:

edited Dec 6, 2017 at 14:50

Salem

15.2k4 gold badges58 silver badges73 bronze badges

answered Dec 6, 2017 at 13:12

Alexey Romanov

172k38 gold badges329 silver badges509 bronze badges

5 Comments

Oliver Charlesworth Over a year ago

What is ownerClassName now?

crgarridos Over a year ago

please provide an (at least) brief explanation how this code works. Thanks

Alexey Romanov Over a year ago

@OliverCharlesworth The name of the object.

Alexey Romanov Over a year ago

@crgarridos Edited, but really looking at the Javadoc for the methods Class#getDeclaredField and for Field#get would give the explanation.

Sahil Doshi Over a year ago

This is failing in case of pro-guard enable. because object class(ownerClassName) is obfuscated.

Chetan Joshi · Accepted Answer · 2025-01-20 11:23:02Z

0

Kotlin instance can be created with below code snipes

    val clazz: KClass<*> = DataRepository::class
    val constructors: Collection<KFunction<Any>> = clazz.constructors
    for (cons in constructors) {
        cons.isAccessible = true
        repository = cons.call(
            param1,
            param2,
            param3,
        ) as DataRepository
    }

answered Jan 20 at 11:23

community wiki

Chetan Joshi

Collectives™ on Stack Overflow

How do I use Kotlin object by reflection

3 Answers 3

9 Comments

5 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

9 Comments

5 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related