Java: throw a more appropriate exception. #199
Merged
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
| throw new InvalidClassException("String length " + size + " exceeds max size " + maxSize); | ||
| throw new IllegalArgumentException("String length " + size + " exceeds max size " + maxSize); |
There was a problem hiding this comment.
Because it's the size inside the stream, and not the maxSize variable, that is illegal, I'm not sure I'd class this as an illegal argument exception (IAE) because the arguments are actually okay it's an issue with data available on the stream and not the function arguments.
BufferOverflowException (BOE) might be more appropriate?
Happy to merge this if you think IAE is the most appropriate exception over BOE. Wdyt?
There was a problem hiding this comment.
Hi @leighmcculloch, BOE is also a suitable choice, but I still prefer to use IAE here.
- In the given code, the exception is triggered when one parameter (size) exceeds another parameter (maxSize). This aligns well with the definition of IAE, which is used when a method receives an inappropriate or invalid argument. In this case, the size being greater than maxSize is due to an incorrect size parameter contained within the passed-in stream.
- IAE is a very common and familiar exception type in Java, widely used to represent various invalid arguments or inappropriate conditions. By using IAE, other developers can quickly understand and handle the exception.
leighmcculloch
approved these changes
Jul 10, 2024
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 is very simple, I think it's more appropriate to throw an
IllegalArgumentExceptionhere.