[go: nahoru, domu]

Add compat methods for new Bundle and Intent APIs

We have introduced new, safer, APIs for Parcel, Bundle and Intent in T
that we want to encourage developers to use. However the APIs have a bug
(b/232589966) which could hinder adoption. As such, we are adding
previously planned Compat methods that developers can use in all Andorid
versios, that will not use the T Apis until U where the bug is addressed.

There are subtle differences in the implementations of the platform
APIs, and so the behaviour of the compat methods:

1. Get Parcelable
public static <T> T getParcelable(@NonNull Bundle in, @Nullable String
key, @NonNull Class<T> clazz)

public static <T> T getParcelableExtra(@NonNull Intent in, @Nullable
String name, @NonNull Class<T> clazz)

These methods match the method signature and behaviour of the post-T,
type-safe APIs - return the value if it exists and is of the `clazz`
type, otherwise return null.

2. Get Collection
public static  <T> ArrayList<T> getParcelableArrayList(@NonNull Bundle
in, @Nullable String key, @NonNull Class<? extends T> clazz)

public static <T> SparseArray<T> getSparseParcelableArray(@NonNull
Bundle in, @Nullable String key, @NonNull Class<? extends T> clazz)

public static <T> ArrayList<T> getParcelableArrayListExtra(@NonNull
Intent in, @Nullable String name, @NonNull Class<? extends T>clazz)

On these methods, the method signature matches the post-T APIs, but type
checking is only done on U+ devices, on first deserialisation. Checking
outside of this scenario requires a linear traversal of the array on each
call, and so is not done for performance  (see b/222087511). Initial
benchmarking shows a 400x difference for large arrays.

3. Get Array

public static Parcelable[] getParcelableArray(@NonNull Bundle in,
@Nullable String key,  @NonNull Class<?> clazz)

public static Parcelable[] getParcelableArrayExtra(@NonNull Intent in,
@Nullable String name, @NonNull Class<?> clazz)

Due to Java generics erasure at runtime, the post-T method signature can
not be safely used on pre-U devices, as the pre-T platform APIs return a
Parcelable[] rather than T[], which can not be implicitely cast to a
subtype even if all items conform. The cost of manually casting is large
(see above). Therefore, we always return Parcelable[] on all device
versions, and we only type-check on U+ devices.

The ParcelCompat methods have been updated to match this behaviour. For
readArray, this is a source breaking API change. But
the current method signature would fail on any current devices if
assigned to anything other than an Object[]  - succeeding
at compile time, but failing with a ClassCastException at runtime.

For readParcelableArray, it has been deprecated and replaced with
readParcelableArrayTyped, as updating the type signature would be a ABI
breaking change for libraries.

Bug: 242048899
Test: atest ParcelCompat BundleCompat IntentCompat on T and U devices
Test: Check binary compatibility manually with a test library.
Relnote: "Adds compatibility methods for new APIs introduced in Android
  13 for Parcels, Bundles, and Intents.
  Note: Some ParcelCompat method signatures have been updated, and may
  require a source change on upgrade to confirm to the new signature."

Change-Id: I57e94c6efcc674173d201205fb175cef495bcf82
11 files changed
tree: a433e9398abae2a7f2bc5aaa2c0929b9c38e2d04
  1. .github/
  2. .idea/
  3. activity/
  4. ads/
  5. annotation/
  6. appactions/
  7. appcompat/
  8. appsearch/
  9. arch/
  10. asynclayoutinflater/
  11. autofill/
  12. benchmark/
  13. biometric/
  14. bluetooth/
  15. browser/
  16. buildSrc/
  17. buildSrc-tests/
  18. busytown/
  19. camera/
  20. car/
  21. cardview/
  22. collection/
  23. compose/
  24. concurrent/
  25. constraintlayout/
  26. contentpager/
  27. coordinatorlayout/
  28. core/
  29. credentials/
  30. cursoradapter/
  31. customview/
  32. datastore/
  33. development/
  34. docs/
  35. docs-kmp/
  36. docs-public/
  37. docs-tip-of-tree/
  38. documentfile/
  39. draganddrop/
  40. drawerlayout/
  41. dynamicanimation/
  42. emoji/
  43. emoji2/
  44. enterprise/
  45. exifinterface/
  46. external/
  47. fragment/
  48. frameworks/
  49. glance/
  50. gradle/
  51. graphics/
  52. gridlayout/
  53. health/
  54. heifwriter/
  55. hilt/
  56. input/
  57. inspection/
  58. interpolator/
  59. javascriptengine/
  60. leanback/
  61. lifecycle/
  62. lint-checks/
  63. loader/
  64. media/
  65. media2/
  66. mediarouter/
  67. metrics/
  68. navigation/
  69. paging/
  70. palette/
  71. percentlayout/
  72. placeholder/
  73. placeholder-tests/
  74. playground-common/
  75. preference/
  76. print/
  77. privacysandbox/
  78. profileinstaller/
  79. recommendation/
  80. recyclerview/
  81. remotecallback/
  82. resourceinspection/
  83. room/
  84. samples/
  85. savedstate/
  86. security/
  87. sharetarget/
  88. slice/
  89. slidingpanelayout/
  90. sqlite/
  91. startup/
  92. swiperefreshlayout/
  93. test/
  94. testutils/
  95. text/
  96. tracing/
  97. transition/
  98. tv/
  99. tvprovider/
  100. vectordrawable/
  101. versionedparcelable/
  102. viewpager/
  103. viewpager2/
  104. wear/
  105. webkit/
  106. window/
  107. work/
  108. .gitignore
  109. .mailmap
  110. build.gradle
  111. cleanBuild.sh
  112. code-review.md
  113. CONTRIBUTING.md
  114. gradle.properties
  115. gradlew
  116. libraryversions.toml
  117. LICENSE.txt
  118. OWNERS
  119. PREUPLOAD.cfg
  120. README.md
  121. settings.gradle
  122. studiow
  123. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Gradle Enterprise

Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.

Jetpack comprises the androidx.* package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.

Our official AARs and JARs binaries are distributed through Google Maven.

You can learn more about using it from Android Jetpack landing page.

Contribution Guide

For contributions via GitHub, see the GitHub Contribution Guide.

Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:

Code Review Etiquette

When contributing to Jetpack, follow the code review etiquette.

Accepted Types of Contributions

  • Bug fixes - needs a corresponding bug report in the Android Issue Tracker
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests
  • New features to existing libraries if the feature request bug has been approved by an AndroidX team member.

We are not currently accepting new modules.

Checking Out the Code

Head over to the onboarding docs to learn more about getting set up and the development workflow!

Continuous integration

Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.

Password and Contributor Agreement before making a change

Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:

Generate a HTTPS password: https://android-review.googlesource.com/new-password

Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing or check the OWNERS file in the project's directory)

Handling binary dependencies

AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal and prebuilts/androidx/external directories in your checkout. All the dependencies in these directories are also available from google(), jcenter(), or mavenCentral(). We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.