fix: Correct Multiset example in TypeAdapterFactory Javadoc#3001
Open
daguimu wants to merge 1 commit intogoogle:mainfrom
Open
fix: Correct Multiset example in TypeAdapterFactory Javadoc#3001daguimu wants to merge 1 commit intogoogle:mainfrom
daguimu wants to merge 1 commit intogoogle:mainfrom
Conversation
The code sample used `typeToken.getRawType() != Multiset.class` which only matches the exact Multiset class, not its subtypes like HashMultiset or LinkedHashMultiset. This causes the factory to return null for all practical Multiset implementations, falling through to CollectionTypeAdapterFactory instead. Change to `!Multiset.class.isAssignableFrom(typeToken.getRawType())` to correctly match all Multiset subtypes. Fixes google#1335
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The
TypeAdapterFactoryJavadoc contains aMultisetTypeAdapterFactorycode sample that does not work in practice. The factory usestypeToken.getRawType() != Multiset.classto check whether the type is a Multiset, but this identity check only matches the exactMultisetinterface, not concrete implementations likeHashMultisetorLinkedHashMultiset. As a result, the factory always returns null and Gson's built-inCollectionTypeAdapterFactoryhandles the type instead.Root Cause
The raw type check uses
!=(reference equality) instead ofisAssignableFrom, so it fails for all Multiset subtypes.Fix
Change
typeToken.getRawType() != Multiset.classto!Multiset.class.isAssignableFrom(typeToken.getRawType()), which correctly matches all Multiset implementations.Impact
Documentation-only change. No runtime behavior affected.
Fixes #1335