Skip to content
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

Fixes the Javadoc of ClaimAccessor methods for Map/List #10129

Closed
wants to merge 1 commit into from
Closed

Fixes the Javadoc of ClaimAccessor methods for Map/List #10129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/ClaimAccessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,9 @@ default URL getClaimAsURL(String claim) {
* Returns the claim value as a {@code Map<String, Object>} or {@code null} if it does
Copy link
Contributor

@jzheaux jzheaux Jul 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the copyright message to "2021".

* not exist or cannot be assigned to a {@code Map}.
* @param claim the name of the claim
* @return the claim value or {@code null} if it does not exist or cannot be assigned
* to a {@code Map}
* @return the claim value or {@code null} if it does not exist
* @throws IllegalArgumentException If the claim exists, but cannot be converted to a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with the rest of the Javadoc, will you please leave "If" lowercased in both of your changes?

* {@code Map}
*/
@SuppressWarnings("unchecked")
default Map<String, Object> getClaimAsMap(String claim) {
Expand All @@ -159,8 +160,9 @@ default Map<String, Object> getClaimAsMap(String claim) {
* Returns the claim value as a {@code List<String>} or {@code null} if it does not
* exist or cannot be assigned to a {@code List}.
* @param claim the name of the claim
* @return the claim value or {@code null} if it does not exist or cannot be assigned
* to a {@code List}
* @return the claim value or {@code null} if it does not exist
* @throws IllegalArgumentException If the claim exists, but cannot be converted to a
* {@code List}
*/
@SuppressWarnings("unchecked")
default List<String> getClaimAsStringList(String claim) {
Expand Down