Building blocks of type-safe builders in Kotlin - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a type-safe builder in Kotlin?

A type-safe builder is a Kotlin programming pattern that uses lambdas with receivers to create DSLs (Domain Specific Languages) that ensure code correctness at compile time by restricting the context and types you can use inside the builder.

beginner

What role does the lambda with receiver play in type-safe builders?

The lambda with receiver allows you to call methods and access properties of the receiver object directly inside the lambda, enabling a clean and readable DSL syntax for building complex objects.

intermediate

Why is the @DslMarker annotation important in type-safe builders?

The @DslMarker annotation helps prevent accidental mixing of scopes from nested builders by restricting which members are accessible, improving safety and clarity in DSL code.

intermediate

How do you define a receiver type in a Kotlin type-safe builder?

You define a receiver type by specifying the receiver class before the lambda parameter, for example: <code>fun build(block: ReceiverType.() -> Unit)</code>. Inside the lambda, <code>this</code> refers to the receiver instance.

beginner

What is the benefit of using type-safe builders over traditional builder patterns?

Type-safe builders provide compile-time safety, cleaner syntax, and better readability by leveraging Kotlin's language features, reducing runtime errors and making DSLs easier to write and maintain.

What Kotlin feature allows a lambda to access the receiver's members directly in a type-safe builder?

A Lambda with receiver

B Extension function

C Higher-order function

D Inline function

Lambda with receiver lets you call the receiver's methods and properties directly inside the lambda, which is key for type-safe builders.

What does the @DslMarker annotation help prevent in Kotlin DSLs?

A Infinite loops

B Null pointer exceptions

C Memory leaks

D Mixing scopes of nested builders

@DslMarker restricts access to members from outer scopes to avoid confusion and errors in nested DSL builders.

In a type-safe builder, what does the this keyword refer to inside the lambda?

A The outer class

B The receiver object

C The lambda itself

D The global scope

Inside the lambda with receiver, this points to the receiver object, allowing direct access to its members.

Which of the following is NOT a benefit of type-safe builders?

A Automatic memory management

B Cleaner syntax

C Compile-time safety

D Better readability

Automatic memory management is handled by the JVM, not by type-safe builders.

How do you declare a function that takes a lambda with receiver in Kotlin?

A fun build(block: (ReceiverType) -> Unit)

B fun build(block: () -> ReceiverType)

C fun build(block: ReceiverType.() -> Unit)

D fun build(block: Unit.() -> ReceiverType)

The syntax ReceiverType.() -> Unit declares a lambda with receiver of type ReceiverType.

Explain how Kotlin's lambda with receiver enables type-safe builders and why it improves code safety.

Think about how the lambda changes the context inside the builder.

Describe the purpose of the @DslMarker annotation and how it helps when building nested DSLs.

Consider what happens when you have multiple layers of builders.

Practice

1. What is the main purpose of type-safe builders in Kotlin?

easy

A. To create complex objects step-by-step with safety and clarity

B. To write faster loops for collections

C. To handle exceptions automatically

D. To convert data types implicitly

Solution

1. Step 1: Understand the concept of type-safe builders

   Type-safe builders allow building complex objects in a structured and safe way using Kotlin's DSL features.

2. Step 2: Identify the main purpose

   The main goal is to create objects step-by-step with clear rules, avoiding errors and improving readability.

3. Final Answer:

   To create complex objects step-by-step with safety and clarity -> Option A

4. Quick Check:

   Type-safe builders = safe, clear object creation [OK]

Hint: Type-safe builders help build objects safely step-by-step [OK]

Common Mistakes:

• Confusing builders with loops or exception handling
• Thinking they convert data types automatically

2. Which Kotlin syntax correctly defines a type-safe builder function named html that takes a lambda with receiver?

easy

A. fun html(block: (Html) -> Unit) { /*...*/ }

B. fun html(block: () -> Html) { /*...*/ }

C. fun html(block: Html.() -> Unit) { /*...*/ }

D. fun html(block: () -> Unit) { /*...*/ }

Solution

1. Step 1: Identify lambda with receiver syntax

   Type-safe builders use lambdas with receiver, which have the form ReceiverType.() -> ReturnType.

2. Step 2: Match the correct function signature

   The function should accept a lambda with receiver Html and return Unit, so Html.() -> Unit is correct.

3. Final Answer:

   fun html(block: Html.() -> Unit) { /*...*/ } -> Option C

4. Quick Check:

   Lambda with receiver = Html.() -> Unit [OK]

Hint: Look for lambda with receiver syntax ReceiverType.() -> Unit [OK]

Common Mistakes:

• Using regular lambda (Html) -> Unit instead of lambda with receiver
• Omitting the receiver type in the lambda
• Returning Html instead of Unit

3. Given the following Kotlin code, what is the output?

class Html {
    val children = mutableListOf<String>()
    fun body(block: Body.() -> Unit) {
        val body = Body()
        body.block()
        children.addAll(body.contents)
    }
    override fun toString() = children.joinToString(", ")
}

class Body {
    val contents = mutableListOf<String>()
    fun p(text: String) {
        contents.add("
$text
")
    }
}

fun html(block: Html.() -> Unit): Html {
    val html = Html()
    html.block()
    return html
}

fun main() {
    val result = html {
        body {
            p("Hello")
            p("World")
        }
    }
    println(result)
}

medium

A. Hello, World

B. <p>Hello</p>, <p>World</p>

C. <body><p>Hello</p><p>World</p></body>

D. Compilation error

Solution

1. Step 1: Understand the builder structure

   The html function creates an Html object, calls body which creates a Body object, then calls p twice adding <p>Hello</p> and <p>World</p> to Body's contents.

2. Step 2: Check how children are collected and printed

   The Html object's children list gets Body's contents added, then toString() joins them with ", ". So output is "<p>Hello</p>, <p>World</p>".

3. Final Answer:

   <p>Hello</p>, <p>World</p> -> Option B

4. Quick Check:

   Children list joined = <p>Hello</p>, <p>World</p> [OK]

Hint: Look for toString join of children list for output [OK]

Common Mistakes:

• Assuming HTML tags are printed as is without escaping
• Expecting full HTML tags like <body> in output
• Thinking code causes compilation error

4. What is the error in this Kotlin builder code snippet?

class Html {
    fun body(block: Body.() -> Unit) {
        val body = Body()
        block()
    }
}

class Body {
    fun p(text: String) { /*...*/ }
}

fun main() {
    val html = Html()
    html.body {
        p("Hello")
    }
}

medium

A. The lambda is called without receiver, so 'p' is unresolved

B. Body class is missing a constructor

C. Html class should inherit from Body

D. The 'body' function should return a value

Solution

1. Step 1: Check how the lambda is called inside body()

   The lambda block is called as block() without receiver, so inside the lambda 'p' is not recognized.

2. Step 2: Identify correct lambda invocation

   It should be called as body.block() to set the receiver to the Body instance, allowing 'p' to be resolved.

3. Final Answer:

   The lambda is called without receiver, so 'p' is unresolved -> Option A

4. Quick Check:

   Lambda call without receiver = unresolved 'p' [OK]

Hint: Call lambda with receiver: use receiver.lambda() syntax [OK]

Common Mistakes:

• Calling lambda without receiver inside builder
• Assuming inheritance fixes builder scope
• Expecting return value from builder function

5. How can you extend a type-safe builder to support nested elements, for example adding a div inside body, while keeping type safety?

hard

A. Use a global div function outside the builder classes

B. Add a div property of type String to Body

C. Make Body inherit from Div

D. Define a div function inside Body that takes a lambda with receiver of a new Div class

Solution

1. Step 1: Understand nested builder pattern

   To support nested elements, define functions inside builder classes that accept lambdas with receivers of nested element classes.

2. Step 2: Apply to 'div' inside 'body'

   Inside Body, define a div function taking Div.() -> Unit lambda, creating a Div instance and applying the lambda to it.

3. Final Answer:

   Define a div function inside Body that takes a lambda with receiver of a new Div class -> Option D

4. Quick Check:

   Nested builders = functions with lambdas with receiver [OK]

Hint: Nested builders use functions with lambdas with receiver inside classes [OK]

Common Mistakes:

• Using simple properties instead of nested builder functions
• Trying inheritance instead of composition
• Defining builder functions outside the class scope