Skip to content

Documentation is wrong about immutability #965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
DarioViva42 opened this issue Sep 2, 2024 · 1 comment · Fixed by #974
Closed

Documentation is wrong about immutability #965

DarioViva42 opened this issue Sep 2, 2024 · 1 comment · Fixed by #974
Milestone
0.12.7

Comments

@DarioViva42
Copy link

DarioViva42 commented Sep 2, 2024 •
edited
Loading

jjwt/api/src/main/java/io/jsonwebtoken/lang/Collections.java

Line 94 in 5812f63

public static <T> Set<T> asSet(Collection<T> c) {

You tell users, that asSet returns an immutable Set.

@return a type-safe immutable {@code Set} containing the specified collection elements.

This is not true, when you pass in a mutable Set. In this case the Collection is only cast to a Set. You probably want to change the documentation or use java.util.Collections.unmodifiableSet
@atanasg atanasg mentioned this issue Oct 31, 2024
Merged
@lhazlewood
Copy link
Contributor

@DarioViva42 sorry for the delay on this! I'm not sure why we didn't see it until recently. Thanks for the PR!

@lhazlewood lhazlewood added this to the 0.12.7 milestone Apr 23, 2025
lhazlewood pushed a commit that referenced this issue Apr 23, 2025
@atanasg
Return immutable Set for a Collection (#974)
1c5e074 
* Return immutable Set for a Collection

Fixes #965
lhazlewood added a commit that referenced this issue Apr 23, 2025
@lhazlewood
Fixes #965.
2e85d6f
@lhazlewood lhazlewood mentioned this issue Apr 23, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.12.7
Development

Successfully merging a pull request may close this issue.

Return immutable Set for a Collection atanasg/jjwt
Updated test case for PR 974 jwtk/jjwt
2 participants
@lhazlewood @DarioViva42