Annotates that a class should not be retained (i.e. used in the return type of the calculation lambda given to the retain {} method in androidx.compose.runtime).
When present on a class, a lint error will be reported when the class or any of its subclasses appear as the generic type of a call to retain. The associated inspection only checks the direct return type of the calculation lambda, but retained values should hold no strong references, direct or indirect, to any type marked as DoNotRetain.
Generally, this annotation is expected to be used on resources that will be leaked if they are retained. Additional or other rationale may be provided by specifying an explanation, which will appear in the lint error message when applicable.
An optional explanation of why this class should not be retained. If this value is not an empty string, it will be presented in the error description at the callsite of offending usages of this type.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-27 UTC."],[],[],null,["DoNotRetain \nArtifact: [androidx.compose.runtime:runtime-annotation](/jetpack/androidx/releases/compose-runtime) \n[View Source](https://cs.android.com/search?q=file:androidx/compose/runtime/annotation/DoNotRetain.kt+class:androidx.compose.runtime.annotation.DoNotRetain) \nAdded in [1.10.0-alpha02](/jetpack/androidx/releases/compose-runtime#1.10.0-alpha02)\nCommon/All\n - Cmn \n\n ```\n @MustBeDocumented\n @Retention(value = AnnotationRetention.BINARY)\n @Target(allowedTargets = [AnnotationTarget.CLASS])\n annotation DoNotRetain\n ```\n\n*** ** * ** ***\n\nAnnotates that a class should not be retained (i.e. used in the return type of the `calculation` lambda given to the `retain {}` method in `androidx.compose.runtime`).\n\nWhen present on a class, a lint error will be reported when the class or any of its subclasses appear as the generic type of a call to `retain`. The associated inspection only checks the direct return type of the `calculation` lambda, but retained values should hold no strong references, direct or indirect, to any type marked as [DoNotRetain](/reference/kotlin/androidx/compose/runtime/annotation/DoNotRetain).\n\nGenerally, this annotation is expected to be used on resources that will be leaked if they are retained. Additional or other rationale may be provided by specifying an [explanation](/reference/kotlin/androidx/compose/runtime/annotation/DoNotRetain#explanation()), which will appear in the lint error message when applicable.\n\nSummary \n\n| Public constructors |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|\n| [DoNotRetain](/reference/kotlin/androidx/compose/runtime/annotation/DoNotRetain#DoNotRetain(kotlin.String))`(explanation: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`)` | Cmn |\n\n| Public properties |\n|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|\n| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | [explanation](/reference/kotlin/androidx/compose/runtime/annotation/DoNotRetain#explanation()) An optional explanation of why this class should not be retained. | Cmn |\n\nPublic constructors \n\nDoNotRetain \nCmn \nAdded in [1.10.0-alpha02](/jetpack/androidx/releases/compose-runtime#1.10.0-alpha02) \n\n```\nDoNotRetain(explanation: String = \"\")\n```\n\nPublic properties \n\nexplanation \nCmn \n\n```\nval explanation: String\n```\n\nAn optional explanation of why this class should not be retained. If this value is not an empty string, it will be presented in the error description at the callsite of offending usages of this type."]]
