Custom getters and setters in Kotlin

Introduction

Custom getters and setters let you control how a property value is read or changed. This helps keep data safe and correct.

When you want to check or change a value before saving it.

When you want to calculate a value on the fly instead of storing it.

When you want to log or track changes to a property.

When you want to hide how a value is stored from outside code.

Syntax

Kotlin

var propertyName: Type = initialValue
    get() {
        // code to run when reading the property
        return field
    }
    set(value) {
        // code to run when setting the property
        field = value
    }

field is a special keyword that refers to the actual stored value.

You can customize either the getter, the setter, or both.

Examples

This getter returns the name in uppercase every time you read it.

Kotlin

var name: String = ""
    get() = field.uppercase()

This setter makes sure age is never negative.

Kotlin

var age: Int = 0
    set(value) {
        field = if (value >= 0) value else 0
    }

This setter prints a message every time the score changes.

Kotlin

var score: Int = 0
    get() = field
    set(value) {
        println("Score changed from $field to $value")
        field = value
    }

Sample Program

This program shows a person with a name and age. The name is trimmed and shown in uppercase. The age cannot be negative.

Kotlin

class Person {
    var name: String = ""
        get() = field.uppercase()
        set(value) {
            field = value.trim()
        }

    var age: Int = 0
        set(value) {
            field = if (value >= 0) value else 0
        }
}

fun main() {
    val person = Person()
    person.name = "  alice  "
    person.age = -5
    println("Name: ${person.name}")
    println("Age: ${person.age}")
}

Important Notes

Use field inside getters and setters to access the actual stored value.

Custom getters can compute values without storing them.

Custom setters can validate or change values before saving.

Summary

Custom getters and setters let you control how properties are read and written.

Use field to access the stored value inside them.

They help keep your data safe and correct.

Practice

1. What is the main purpose of custom getters and setters in Kotlin?

easy

A. To create new classes automatically

B. To define functions outside a class

C. To control how properties are read and written

D. To import external libraries

Solution

1. Step 1: Understand property access

   Custom getters and setters allow you to define how a property value is retrieved or changed.

2. Step 2: Identify their purpose

   They help control and protect the data by customizing read/write behavior.

3. Final Answer:

   To control how properties are read and written -> Option C

4. Quick Check:

   Custom getters/setters = control property access [OK]

Hint: Remember: getters/setters control property reading/writing [OK]

Common Mistakes:

• Confusing getters/setters with class creation
• Thinking they define functions outside classes
• Assuming they import libraries

2. Which of the following is the correct syntax to define a custom setter for a Kotlin property age?

easy

A. var age: Int
set(value) { field = value }

B. var age: Int
get(value) { field = value }

C. val age: Int
set(value) { field = value }

D. var age: Int
set { value = field }

Solution

1. Step 1: Check property mutability

   Setter can only be defined for var, not val.

2. Step 2: Verify setter syntax

   The setter uses set(value) { field = value } to assign the new value.

3. Final Answer:

   var age: Int set(value) { field = value } -> Option A

4. Quick Check:

   Setter syntax = set(value) { field = value } [OK]

Hint: Setter needs var and set(value) syntax [OK]

Common Mistakes:

• Using get instead of set for setter
• Defining setter on val property
• Reversing field and value in setter

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

class Person {
    var name: String = ""
        get() = field.uppercase()
        set(value) { field = value.trim() }
}

fun main() {
    val p = Person()
    p.name = "  alice  "
    println(p.name)
}

medium

A. ALICE

B. alice

C. ecila

D. Alice

Solution

1. Step 1: Analyze setter behavior

   Setter trims the input, so " alice " becomes "alice" stored in field.

2. Step 2: Analyze getter behavior

   Getter returns the stored value in uppercase, so "alice" becomes "ALICE".

3. Final Answer:

   ALICE -> Option A

4. Quick Check:

   Setter trims, getter uppercases = ALICE [OK]

Hint: Setter trims, getter uppercases output [OK]

Common Mistakes:

• Ignoring trimming in setter
• Not converting to uppercase in getter
• Assuming original input prints

4. Identify the error in this Kotlin class with custom getter and setter:

class Box {
    var size: Int = 0
        get() = field
        set(value) {
            if (value > 0) field = value
            else field = 0
        }

    fun printSize() {
        println(size)
    }
}

medium

A. Setter does not assign value correctly

B. No error, code works fine

C. Getter should not use field

D. Property size should be val, not var

Solution

1. Step 1: Check setter logic

   Setter assigns field = value if positive, else 0. This is valid.

2. Step 2: Check getter and property type

   Getter returns field, which is correct. Property is var, so setter allowed.

3. Final Answer:

   No error, code works fine -> Option B

4. Quick Check:

   Setter and getter correct = no error [OK]

Hint: Setter with condition is valid; getter uses field correctly [OK]

Common Mistakes:

• Thinking getter can't use field
• Assuming setter must always assign value
• Confusing var and val for setters

5. You want a Kotlin property score that never stores a negative value. Which custom setter implementation ensures this correctly?

hard

A. var score: Int = 0
set(value) { field = value * -1 }

B. var score: Int = 0
set(value) { if (value < 0) field = 0 }

C. var score: Int = 0
set(value) { field = value }

D. var score: Int = 0
set(value) { field = if (value < 0) 0 else value }

Solution

1. Step 1: Understand requirement

   Property must never store negative values; negative inputs become zero.

2. Step 2: Evaluate each setter

   var score: Int = 0 set(value) { field = if (value < 0) 0 else value } sets field to 0 if value is negative, else stores value correctly.

3. Step 3: Check other options

   A stores negative of value, which can be positive or negative incorrectly; B only sets field if negative, ignoring positive values; C stores negatives unchanged.

4. Final Answer:

   var score: Int = 0 set(value) { field = if (value < 0) 0 else value } -> Option D

5. Quick Check:

   Setter with if-else ensures no negatives [OK]

Hint: Use if-else in setter to block negatives [OK]

Common Mistakes:

• Not assigning field for positive values
• Allowing negative values to be stored
• Incorrectly negating values