-
Notifications
You must be signed in to change notification settings - Fork 416
Add Kotlin Parcelize snippets #1049
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
erikrodriguez-se
wants to merge
1
commit into
android:main
Choose a base branch
from
StellarElements:parcelize-snippets
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
205 changes: 205 additions & 0 deletions
205
kotlin/src/main/kotlin/com/example/android/basics/Parcelize.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| /* | ||
| * Copyright 2026 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.android.basics | ||
|
|
||
| import android.os.Parcel | ||
| import android.os.Parcelable | ||
| import kotlinx.parcelize.DataClass | ||
| import kotlinx.parcelize.IgnoredOnParcel | ||
| import kotlinx.parcelize.Parceler | ||
| import kotlinx.parcelize.Parcelize | ||
| import kotlinx.parcelize.RawValue | ||
| import kotlinx.parcelize.TypeParceler | ||
| import kotlinx.parcelize.WriteWith | ||
| import kotlinx.parcelize.parcelableCreator | ||
|
|
||
| private object BasicSnippet { | ||
| // [START android_kotlin_parcelize_basic] | ||
| // import kotlinx.parcelize.Parcelize | ||
|
|
||
| @Parcelize | ||
| class User(val firstName: String, val lastName: String, val age: Int) : Parcelable | ||
| // [END android_kotlin_parcelize_basic] | ||
| } | ||
|
|
||
| private object CompanionParcelerSnippet { | ||
| // [START android_kotlin_parcelize_companion_parceler] | ||
| @Parcelize | ||
| data class User(val firstName: String, val lastName: String, val age: Int) : Parcelable { | ||
| private companion object : Parceler<User> { | ||
| override fun User.write(parcel: Parcel, flags: Int) { | ||
| // Custom write implementation | ||
| } | ||
|
|
||
| override fun create(parcel: Parcel): User { | ||
| // Custom read implementation | ||
| // [START_EXCLUDE silent] | ||
| return User("", "", 0) | ||
| // [END_EXCLUDE] | ||
| } | ||
| } | ||
| } | ||
| // [END android_kotlin_parcelize_companion_parceler] | ||
| } | ||
|
|
||
| private object ExternalClassParcelerSnippet { | ||
| // [START android_kotlin_parcelize_external_class_parceler] | ||
| class ExternalClass(val value: Int) | ||
|
|
||
| object ExternalClassParceler : Parceler<ExternalClass> { | ||
| override fun create(parcel: Parcel) = ExternalClass(parcel.readInt()) | ||
|
|
||
| override fun ExternalClass.write(parcel: Parcel, flags: Int) { | ||
| parcel.writeInt(value) | ||
| } | ||
| } | ||
| // [END android_kotlin_parcelize_external_class_parceler] | ||
| } | ||
|
|
||
| private object ClassLocalParcelerSnippet { | ||
| class ExternalClass(val value: Int) | ||
|
|
||
| object ExternalClassParceler : Parceler<ExternalClass> { | ||
| override fun create(parcel: Parcel) = ExternalClass(parcel.readInt()) | ||
|
|
||
| override fun ExternalClass.write(parcel: Parcel, flags: Int) { | ||
| parcel.writeInt(value) | ||
| } | ||
| } | ||
|
|
||
| // [START android_kotlin_parcelize_type_parceler_class] | ||
| // Class-local parceler | ||
| @Parcelize | ||
| @TypeParceler<ExternalClass, ExternalClassParceler>() | ||
| class MyClass(val external: ExternalClass) : Parcelable | ||
| // [END android_kotlin_parcelize_type_parceler_class] | ||
| } | ||
|
|
||
| private object PropertyLocalParcelerSnippet { | ||
| class ExternalClass(val value: Int) | ||
|
|
||
| object ExternalClassParceler : Parceler<ExternalClass> { | ||
| override fun create(parcel: Parcel) = ExternalClass(parcel.readInt()) | ||
|
|
||
| override fun ExternalClass.write(parcel: Parcel, flags: Int) { | ||
| parcel.writeInt(value) | ||
| } | ||
| } | ||
|
|
||
| // [START android_kotlin_parcelize_type_parceler_property] | ||
| // Property-local parceler | ||
| @Parcelize | ||
| class MyClass(@TypeParceler<ExternalClass, ExternalClassParceler>() val external: ExternalClass) : Parcelable | ||
| // [END android_kotlin_parcelize_type_parceler_property] | ||
| } | ||
|
|
||
| private object TypeLocalParcelerSnippet { | ||
| class ExternalClass(val value: Int) | ||
|
|
||
| object ExternalClassParceler : Parceler<ExternalClass> { | ||
| override fun create(parcel: Parcel) = ExternalClass(parcel.readInt()) | ||
|
|
||
| override fun ExternalClass.write(parcel: Parcel, flags: Int) { | ||
| parcel.writeInt(value) | ||
| } | ||
| } | ||
|
|
||
| // [START android_kotlin_parcelize_type_parceler_type] | ||
| // Type-local parceler | ||
| @Parcelize | ||
| class MyClass(val external: @WriteWith<ExternalClassParceler>() ExternalClass) : Parcelable | ||
| // [END android_kotlin_parcelize_type_parceler_type] | ||
| } | ||
|
|
||
| private object ParcelableCreatorSnippet { | ||
| @Parcelize | ||
| class User(val firstName: String, val lastName: String, val age: Int) : Parcelable | ||
|
|
||
| // [START android_kotlin_parcelize_parcelable_creator] | ||
| // import kotlinx.parcelize.parcelableCreator | ||
|
|
||
| fun userFromParcel(parcel: Parcel): User { | ||
| return parcelableCreator<User>().createFromParcel(parcel) | ||
| } | ||
| // [END android_kotlin_parcelize_parcelable_creator] | ||
| } | ||
|
|
||
| private object IgnoredOnParcelSnippet { | ||
| // [START android_kotlin_parcelize_ignored_on_parcel] | ||
| @Parcelize | ||
| class MyClass( | ||
| val include: String, | ||
| // Don't serialize this property | ||
| @IgnoredOnParcel val ignore: String = "default" | ||
| ) : Parcelable { | ||
| // Silence a warning | ||
| @IgnoredOnParcel | ||
| val computed: String = include + ignore | ||
| } | ||
| // [END android_kotlin_parcelize_ignored_on_parcel] | ||
| } | ||
|
|
||
| private object RawValueSnippet { | ||
| class ExternalClass(val value: Int) | ||
|
|
||
| // [START android_kotlin_parcelize_raw_value] | ||
| @Parcelize | ||
| class MyClass(val external: @RawValue ExternalClass) : Parcelable | ||
| // [END android_kotlin_parcelize_raw_value] | ||
| } | ||
|
|
||
| private object SealedClassSnippet { | ||
| // [START android_kotlin_parcelize_sealed_class] | ||
| @Parcelize | ||
| sealed class SealedClass : Parcelable { | ||
| class A(val a: String) : SealedClass() | ||
| class B(val b: Int) : SealedClass() | ||
| } | ||
|
|
||
| @Parcelize | ||
| class MyClass(val a: SealedClass.A, val b: SealedClass.B, val c: SealedClass) : Parcelable | ||
| // [END android_kotlin_parcelize_sealed_class] | ||
| } | ||
|
|
||
| private object DataWrapperSnippet { | ||
| // [START android_kotlin_parcelize_data_class_wrapper] | ||
| // Common code: | ||
| data class MyData(val x: String, val y: MoreData) | ||
| data class MoreData(val a: String, val b: Int) | ||
|
|
||
| // Platform code: | ||
| @OptIn(kotlinx.parcelize.Experimental::class) | ||
| @Parcelize | ||
| class DataWrapper(val wrapped: @DataClass MyData) : Parcelable | ||
| // [END android_kotlin_parcelize_data_class_wrapper] | ||
| } | ||
|
|
||
| private object InheritanceBaseSnippet { | ||
| // [START android_kotlin_parcelize_inheritance_base] | ||
| // base parcelize | ||
| @Parcelize | ||
| open class Base(open val s: String) : Parcelable | ||
|
|
||
| @Parcelize | ||
| class Derived( | ||
| val x: Int, | ||
| // all arguments have to be `val` or `var` so we need to override | ||
| // to not introduce new property name | ||
| override val s: String | ||
| ) : Base(s) | ||
| // [END android_kotlin_parcelize_inheritance_base] | ||
| } |
34 changes: 34 additions & 0 deletions
34
kotlin/src/main/kotlin/com/example/android/basics/ParcelizeDataClass.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Copyright 2026 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| @file:OptIn(kotlinx.parcelize.Experimental::class) | ||
|
|
||
| package com.example.android.basics | ||
|
|
||
| import android.os.Parcelable | ||
| import kotlinx.parcelize.DataClass | ||
| import kotlinx.parcelize.Parcelize | ||
|
|
||
| private object DataClassSnippet { | ||
| // [START android_kotlin_parcelize_data_class] | ||
| // @file:OptIn(kotlinx.parcelize.Experimental::class) | ||
|
|
||
| data class C(val a: Int, val b: String) | ||
|
|
||
| @Parcelize | ||
| class P(val c: @DataClass C) : Parcelable | ||
| // [END android_kotlin_parcelize_data_class] | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not in the original fork PR but this is a linter nit worth addressing since we're touching the file