Map-backed delegated properties in Kotlin

Introduction

Map-backed delegated properties let you store and access object properties using a map. This helps when you want flexible or dynamic property storage without writing many variables.

When you want to create objects with properties that can change at runtime.

When you want to read or write properties from a map without manually coding each property.

When you want to easily convert JSON or other key-value data into Kotlin objects.

When you want to reduce boilerplate code for classes with many similar properties.

Syntax

Kotlin

import kotlin.reflect.KProperty

class MapDelegate(val map: Map<String, Any?>) {
    operator fun <V> getValue(thisRef: Any?, property: KProperty<*>): V = (map[property.name] ?: error("No value for '${property.name}'")) as V
}

class MyClass(val map: Map<String, Any?>) {
    val prop: String by MapDelegate(map)
}

The property is delegated to the map using by MapDelegate(map).

The map keys must match the property names exactly.

Examples

This class reads name and age from the map keys.

Kotlin

import kotlin.reflect.KProperty

class MapDelegate(val map: Map<String, Any?>) {
    operator fun <V> getValue(thisRef: Any?, property: KProperty<*>): V = (map[property.name] ?: error("No value for '${property.name}'")) as V
}

class User(val map: Map<String, Any?>) {
    val name: String by MapDelegate(map)
    val age: Int by MapDelegate(map)
}

Creates a map and accesses properties via the delegated properties.

Kotlin

val userData = mapOf("name" to "Anna", "age" to 28)
val user = User(userData)
println(user.name)  // prints Anna
println(user.age)   // prints 28

Sample Program

This program creates a Person class with properties delegated to a map. It prints the person's full name and age.

Kotlin

import kotlin.reflect.KProperty

class MapDelegate(val map: Map<String, Any?>) {
    operator fun <V> getValue(thisRef: Any?, property: KProperty<*>): V = (map[property.name] ?: error("No value for '${property.name}'")) as V
}

class Person(val map: Map<String, Any?>) {
    val firstName: String by MapDelegate(map)
    val lastName: String by MapDelegate(map)
    val age: Int by MapDelegate(map)
}

fun main() {
    val data = mapOf("firstName" to "John", "lastName" to "Doe", "age" to 30)
    val person = Person(data)
    println("Name: ${person.firstName} ${person.lastName}")
    println("Age: ${person.age}")
}

Important Notes

If the map does not contain a key matching the property name, the program will throw an exception.

Map-backed properties are read-only by default. To make them mutable, you need a MutableMap and use var with delegation.

Summary

Map-backed delegated properties let you link class properties to map entries easily.

This reduces boilerplate when working with dynamic or flexible data.

Property names must match map keys exactly for this to work.

Practice

1. What is the main purpose of using Map-backed delegated properties in Kotlin?

easy

A. To convert maps into JSON strings automatically

B. To link class properties directly to entries in a map

C. To perform arithmetic operations on map values

D. To create immutable lists easily

Solution

1. Step 1: Understand the concept of map-backed delegation

   Map-backed delegated properties allow class properties to get and set values directly from a map using the property name as the key.

2. Step 2: Identify the main purpose

   This reduces boilerplate code when working with dynamic data by linking properties to map entries.

3. Final Answer:

   To link class properties directly to entries in a map -> Option B

4. Quick Check:

   Map-backed delegation links properties to map keys [OK]

Hint: Remember: properties match map keys exactly [OK]

Common Mistakes:

• Thinking it creates immutable lists
• Assuming it converts maps to JSON
• Confusing it with arithmetic operations on maps

2. Which of the following is the correct syntax to declare a property name delegated to a map map in Kotlin?

easy

A. val name by map["name"]

B. val name = map["name"]

C. val name by map.get("name")

D. val name by map

Solution

1. Step 1: Recall the syntax for map-backed delegated properties

   In Kotlin, you delegate a property to a map using val property by map, where the property name matches the map key.

2. Step 2: Analyze each option

   val name by map uses the correct syntax. val name by map["name"] tries to delegate to a map entry, which is invalid. val name by map.get("name") calls a function, not delegation. val name = map["name"] just assigns the value, not delegation.

3. Final Answer:

   val name by map -> Option D

4. Quick Check:

   Property delegation uses 'by map' syntax [OK]

Hint: Use 'by map' with property name matching key [OK]

Common Mistakes:

• Trying to delegate to map entry like map["key"]
• Using map.get() instead of delegation
• Assigning value directly without delegation

3. What will be the output of the following Kotlin code?

class User(val map: Map<String, Any?>) {
    val name: String by map
    val age: Int by map
}

fun main() {
    val user = User(mapOf("name" to "Alice", "age" to 30))
    println("Name: ${user.name}, Age: ${user.age}")
}

medium

A. Name: Alice, Age: 30

B. Name: null, Age: 0

C. Compilation error due to type mismatch

D. Runtime exception due to missing keys

Solution

1. Step 1: Understand map-backed delegation behavior

   The properties name and age delegate to the map keys "name" and "age" respectively, retrieving their values.

2. Step 2: Check the map contents and output

   The map contains "name" as "Alice" and "age" as 30, so printing these properties outputs "Name: Alice, Age: 30".

3. Final Answer:

   Name: Alice, Age: 30 -> Option A

4. Quick Check:

   Map keys match properties, so values print correctly [OK]

Hint: Property names must match map keys exactly [OK]

Common Mistakes:

• Expecting null or default values
• Confusing delegation with direct assignment
• Assuming runtime error without missing keys

4. Identify the error in this Kotlin code using map-backed delegated properties:

class Person(val map: Map<String, Any>) {
    val firstName: String by map
    val lastName: String by map
}

fun main() {
    val data = mapOf("firstName" to "John")
    val person = Person(data)
    println(person.lastName)
}

medium

A. No error; prints null for missing key

B. Compilation error because map type is incorrect

C. Runtime exception due to missing key "lastName" in map

D. Syntax error in property delegation

Solution

1. Step 1: Check map keys vs delegated properties

   The map contains only "firstName", but the class expects both "firstName" and "lastName" keys for delegation.

2. Step 2: Understand behavior on missing keys

   Accessing person.lastName tries to get a missing key, causing a runtime exception (NoSuchElementException).

3. Final Answer:

   Runtime exception due to missing key "lastName" in map -> Option C

4. Quick Check:

   Missing map keys cause runtime errors [OK]

Hint: All delegated keys must exist in the map [OK]

Common Mistakes:

• Assuming missing keys return null
• Thinking it's a compile-time error
• Ignoring runtime exceptions on missing keys

5. Given a map data = mapOf("x" to 10, "y" to 20, "z" to 0), how can you create a Kotlin class Point with map-backed delegated properties x, y, and z but only expose x and y publicly, hiding z internally?

hard

A. Declare val x: Int by map, val y: Int by map as public and private val z: Int by map

B. Declare all properties as val without visibility modifiers

C. Use var for z and val for others

D. Exclude z from the map passed to the class

Solution

1. Step 1: Understand visibility modifiers in Kotlin

   Properties can be declared with private to hide them from outside the class.

2. Step 2: Apply visibility to map-backed properties

   Declare x and y as public (default) and z as private val z: Int by map to hide it internally.

3. Final Answer:

   Declare val x: Int by map, val y: Int by map as public and private val z: Int by map -> Option A

4. Quick Check:

   Use 'private' modifier to hide delegated properties [OK]

Hint: Use 'private' keyword to hide properties [OK]

Common Mistakes:

• Assuming all properties are public by default
• Trying to exclude keys from the map instead of hiding
• Confusing var and val for visibility