Improve error message for requiredType mismatch in NamespacedHierarchicalStore
#3601
Conversation
This file contains 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
Prior to this commit, the error message just contained the key and the requiredType, but gave no indication what was actually present. Now, the error message also includes the type of the actual value as well as its toString() representation.
marcphilipp
approved these changes
Dec 15, 2023
|
@leonard84 Thanks! 👍 |
sbrannen
reviewed
Dec 15, 2023
| @@ -252,7 +252,8 @@ private <T> T castToRequiredType(Object key, Object value, Class<T> requiredType | |||
| } | |||
| // else | |||
| throw new NamespacedHierarchicalStoreException( | |||
| String.format("Object stored under key [%s] is not of required type [%s]", key, requiredType.getName())); | |||
| String.format("Object stored under key [%s] is not of required type [%s], but was [%s]: %s", key, | |||
| requiredType.getName(), value.getClass(), value)); | |||
There was a problem hiding this comment.
For future reference, please note that we typically invoke Class#getName when including types in messages, analogous to requireType.getName() on the same line.
I'll polish that on main since this has already been merged.
Thanks for the PR! 👍
There was a problem hiding this comment.
Makes sense, I overlooked that it included the class prefix.
sbrannen
changed the title
requiredType mismatch in NamespacedHierarchicalStore
sbrannen
added a commit
that referenced
this pull request
Dec 15, 2023
This pull request was closed.
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.
Overview
Prior to this commit, the error message just contained the key and the requiredType, but gave no indication what was actually present. Now, the error message also includes the type of the actual value as well as its toString() representation.
I hereby agree to the terms of the JUnit Contributor License Agreement.
Definition of Done
@APIannotations