Saving instance state in Android Kotlin

Introduction

Saving instance state helps keep your app's data safe when the screen rotates or the app is temporarily stopped. It prevents losing what the user was doing.

When the user rotates the phone and you want to keep the current screen data.

When the app goes to the background and might be killed by the system.

When you want to save temporary user input like text typed in a form.

When you want to restore UI state like scroll position after a configuration change.

Syntax

Android Kotlin

override fun onSaveInstanceState(outState: Bundle) {
  super.onSaveInstanceState(outState)
  outState.putString("key", "value")
}

override fun onRestoreInstanceState(savedInstanceState: Bundle) {
  super.onRestoreInstanceState(savedInstanceState)
  val value = savedInstanceState.getString("key")
}

Use onSaveInstanceState to save data before the activity is destroyed.

Use onRestoreInstanceState or savedInstanceState in onCreate to restore data.

Examples

Saves an integer value with the key "score".

Android Kotlin

override fun onSaveInstanceState(outState: Bundle) {
  super.onSaveInstanceState(outState)
  outState.putInt("score", 42)
}

Restores the integer value saved with the key "score".

Android Kotlin

override fun onRestoreInstanceState(savedInstanceState: Bundle) {
  super.onRestoreInstanceState(savedInstanceState)
  val score = savedInstanceState.getInt("score")
}

Saves a boolean value to remember if a checkbox was checked.

Android Kotlin

override fun onSaveInstanceState(outState: Bundle) {
  super.onSaveInstanceState(outState)
  outState.putBoolean("isChecked", true)
}

Sample App

This app has a button that increases a number shown on screen. When you rotate the phone, the number stays the same because it is saved and restored using instance state.

Android Kotlin

import android.os.Bundle
import android.widget.Button
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity

class MainActivity : AppCompatActivity() {
  private var counter = 0
  private lateinit var counterText: TextView

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    counterText = findViewById(R.id.counterText)
    val button = findViewById<Button>(R.id.incrementButton)

    if (savedInstanceState != null) {
      counter = savedInstanceState.getInt("counter")
    }
    counterText.text = counter.toString()

    button.setOnClickListener {
      counter++
      counterText.text = counter.toString()
    }
  }

  override fun onSaveInstanceState(outState: Bundle) {
    super.onSaveInstanceState(outState)
    outState.putInt("counter", counter)
  }
}

Important Notes

Always call super.onSaveInstanceState(outState) to let the system save default state.

Instance state is for small amounts of data like UI state, not for large files or databases.

Data saved in instance state is lost if the app is fully closed or the device restarts.

Summary

Saving instance state keeps UI data safe during screen rotations or temporary stops.

Use onSaveInstanceState to save data and onRestoreInstanceState or savedInstanceState in onCreate to restore it.

Good for saving small, temporary data like counters, text input, or checkbox states.

Practice

1. What is the main purpose of onSaveInstanceState in Android Kotlin apps?

easy

A. To initialize UI components when the app starts

B. To permanently store data in a database

C. To save UI data temporarily during events like screen rotation

D. To handle user input events like button clicks

Solution

1. Step 1: Understand the role of onSaveInstanceState

   This method is called before an activity might be destroyed, such as during screen rotation, to save temporary UI data.

2. Step 2: Differentiate from other data storage methods

   Permanent storage like databases is not handled here; onSaveInstanceState is for short-term state saving only.

3. Final Answer:

   To save UI data temporarily during events like screen rotation -> Option C

4. Quick Check:

   onSaveInstanceState saves temporary UI state [OK]

Hint: Remember: onSaveInstanceState saves temporary UI data [OK]

Common Mistakes:

• Confusing onSaveInstanceState with permanent storage
• Thinking it initializes UI components
• Assuming it handles user input events

2. Which of the following is the correct way to save a string value "username" in onSaveInstanceState?

easy

A. bundle.putString("username", username)

B. outState.putString("username", username)

C. savedInstanceState.putString("username", username)

D. state.putString("username", username)

Solution

1. Step 1: Identify the correct parameter name in onSaveInstanceState

   The Bundle parameter is named outState in onSaveInstanceState method.

2. Step 2: Use the correct method to save a string

   Use outState.putString(key, value) to save the string value.

3. Final Answer:

   outState.putString("username", username) -> Option B

4. Quick Check:

   Use outState to save data in onSaveInstanceState [OK]

Hint: Use outState.putString() inside onSaveInstanceState [OK]

Common Mistakes:

• Using savedInstanceState inside onSaveInstanceState
• Using undefined variable names like bundle or state
• Confusing parameter names in lifecycle methods

3. Given this code snippet inside an Activity:

override fun onSaveInstanceState(outState: Bundle) {
  super.onSaveInstanceState(outState)
  outState.putInt("score", 10)
}

override fun onCreate(savedInstanceState: Bundle?) {
  super.onCreate(savedInstanceState)
  val score = savedInstanceState?.getInt("score") ?: 0
  println(score)
}

What will be printed after a screen rotation?

medium

A. Crash due to NullPointerException

B. 0

C. null

D. 10

Solution

1. Step 1: Understand saving the score in onSaveInstanceState

   The score 10 is saved in the outState bundle before the activity is destroyed.

2. Step 2: Restore score in onCreate after rotation

   savedInstanceState contains the saved bundle, so getInt("score") returns 10, not null or 0.

3. Final Answer:

   10 -> Option D

4. Quick Check:

   Saved state restores score = 10 after rotation [OK]

Hint: savedInstanceState?.getInt() returns saved value or default [OK]

Common Mistakes:

• Assuming savedInstanceState is always null
• Forgetting to call super.onSaveInstanceState
• Expecting 0 instead of restored value

4. What is wrong with this code snippet for saving instance state?

override fun onSaveInstanceState(outState: Bundle) {
  outState.putInt("count", count)
}

override fun onCreate(savedInstanceState: Bundle?) {
  super.onCreate(savedInstanceState)
  val count = savedInstanceState?.getInt("count") ?: 0
}

medium

A. Missing call to super.onSaveInstanceState in onSaveInstanceState

B. Using wrong key name "count"

C. Not initializing count variable before saving

D. Not checking savedInstanceState for null in onCreate

Solution

1. Step 1: Check onSaveInstanceState method

   It lacks a call to super.onSaveInstanceState(outState), which is required to save default state.

2. Step 2: Verify other parts

   Key name "count" is consistent, count variable assumed initialized, and null check is done in onCreate.

3. Final Answer:

   Missing call to super.onSaveInstanceState in onSaveInstanceState -> Option A

4. Quick Check:

   Always call super.onSaveInstanceState [OK]

Hint: Always call super.onSaveInstanceState in override [OK]

Common Mistakes:

• Forgetting super call in onSaveInstanceState
• Using inconsistent keys for saving/restoring
• Ignoring null checks on savedInstanceState

5. You want to save a checkbox state and a user input text during screen rotation. Which approach correctly saves and restores both in an Activity?

hard

A. Save checkbox state and text in onSaveInstanceState using outState.putBoolean and outState.putString, then restore in onCreate using savedInstanceState?.getBoolean and getString

B. Save checkbox state only in onSaveInstanceState, restore text from a global variable

C. Save text in onPause and checkbox state in onStop, restore both in onResume

D. Use SharedPreferences to save checkbox and text, restore in onCreate

Solution

1. Step 1: Use onSaveInstanceState for temporary UI data

   Checkbox state (boolean) and text (string) should be saved in outState bundle in onSaveInstanceState.

2. Step 2: Restore saved data in onCreate

   Use savedInstanceState?.getBoolean and getString to restore checkbox and text after rotation.

3. Final Answer:

   Save checkbox state and text in onSaveInstanceState using outState.putBoolean and outState.putString, then restore in onCreate using savedInstanceState?.getBoolean and getString -> Option A

4. Quick Check:

   Use onSaveInstanceState and savedInstanceState for UI state [OK]

Hint: Save UI data in onSaveInstanceState, restore in onCreate [OK]

Common Mistakes:

• Using global variables that reset on rotation
• Saving data in lifecycle methods not meant for state
• Using persistent storage for temporary UI state