chore(heatmaps): Port heatmaps package to Kotlin #1573
Merged
Conversation
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
The `@Deprecated` annotation has been updated to the Kotlin syntax and now includes a `ReplaceWith` expression to provide IDE quick-fix support. Additionally, new unit tests using Google Truth have been added for the `Point` class to verify its construction and inheritance.
This commit migrates the `Gradient` and `WeightedLatLng` classes and their corresponding tests from Java to idiomatic Kotlin. This conversion is part of the larger effort to modernize the library and prepare it for Kotlin Multiplatform (KMP) compatibility. Key changes include: - `WeightedLatLng` is now a `data class` with a private primary constructor to ensure correct instantiation while providing the benefits of auto-generated methods. The `@ExposedCopyVisibility` annotation has been added to maintain binary compatibility for the `copy()` method. - `Gradient` has been converted to a Kotlin class, using `@JvmOverloads` for constructor compatibility and a `companion object` for its static helper method. - The `internal` visibility of a method in `Gradient` was changed to `public` to ensure visibility to Java classes during the mixed-language phase of the migration. - Unit tests for both classes have been ported to Kotlin, using the Truth assertion framework.
This commit completes the migration of the `heatmaps` package to Kotlin by porting the final and most complex class, `HeatmapTileProvider`. This conversion modernizes the class by introducing several idiomatic Kotlin features and improves its design by refactoring a key data structure. Key changes include: - The `HeatmapTileProvider` and its `Builder` are now written in Kotlin. - The `getMaxValue()` method was refactored to use a `Map` with a type-safe `Vector` key instead of the Android-specific `LongSparseArray`, improving readability and moving closer to KMP compatibility. - A new test suite was created from scratch for the provider, as none existed previously. This improves the code coverage and reliability of the module. - Necessary adjustments were made to the demo application to support the newly ported Kotlin class.
Updates the copyright headers in the test files that were created during the Kotlin porting process. - Corrects the copyright year to 2025. - Corrects the company name from "Google Inc." to "Google LLC".
Updates the copyright headers in the `heatmaps` package source and test files. - Corrects the copyright year to 2025. - Corrects the company name from "Google Inc." to "Google LLC".
dkhawk
changed the title
Code Coverage
|
kikoso
reviewed
Aug 28, 2025
library/src/main/java/com/google/maps/android/heatmaps/Gradient.kt
Outdated
Show resolved
Hide resolved
kikoso
reviewed
Aug 28, 2025
library/src/main/java/com/google/maps/android/heatmaps/HeatmapTileProvider.kt
Show resolved
Hide resolved
Addresses feedback to make the heatmap API more intuitive and robust. - Renames `setWeightedData` and `setData` in `HeatmapTileProvider` to `updateData` and `updateLatLngs` respectively. The `update` prefix better communicates that these methods perform expensive operations that rebuild internal state, rather than just setting a property. - The old method names are preserved and marked as `@Deprecated` to provide a smooth migration path for existing users and avoid a breaking change. - Adds a default value of 0.7 to the `opacity` parameter in `Gradient.generateColorMap`. This aligns with the default in `HeatmapTileProvider` and simplifies common use cases. - Annotates `generateColorMap` with `@JvmOverloads` to ensure the new default parameter is exposed correctly to Java clients. - Improves KDoc for all modified methods to be more descriptive, explaining the purpose of the code and the reasoning behind the design choices.
Updates the `generateColorMap` function to use the `HeatmapTileProvider.DEFAULT_OPACITY` constant for its default opacity value. This removes a hardcoded value, improving maintainability and ensuring the default remains consistent with the provider. The accompanying KDoc has also been corrected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR completes the full migration of the com.google.maps.android.heatmaps package from Java to idiomatic Kotlin.
This effort included:
WeightedLatLng,Gradient, andHeatmapTileProviderto Kotlin.LongSparseArraywith aMap) to be more idiomatic and platform-agnostic.HeatmapTileProviderto improve code coverage.