Skip to content

Clearly document that DataClassRowMapper supports Java records #29814

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.

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

Closed
sbrannen opened this issue Jan 13, 2023 · 0 comments
Closed

Clearly document that DataClassRowMapper supports Java records #29814

sbrannen opened this issue Jan 13, 2023 · 0 comments
Assignees
Labels
in: data Issues in data modules (jdbc, orm, oxm, tx) status: backported An issue that has been backported to maintenance branches type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

The current Javadoc for DataClassRowMapper is a bit vague and does not spell out that it actually supports Java records.

We should improve the documentation to make that clear.

In addition, we should improve the documentation for BeanPropertyRowMapper by explaining when DataClassRowMapper would be a better choice (i.e., for records or Kotlin data classes) -- the current @see DataClassRowMapper is not really sufficient for that.

@sbrannen sbrannen added in: data Issues in data modules (jdbc, orm, oxm, tx) type: documentation A documentation task labels Jan 13, 2023
@sbrannen sbrannen added this to the 6.0.5 milestone Jan 13, 2023
@sbrannen sbrannen self-assigned this Jan 16, 2023
@github-actions github-actions bot added status: backported An issue that has been backported to maintenance branches and removed for: backport-to-5.3.x labels Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: data Issues in data modules (jdbc, orm, oxm, tx) status: backported An issue that has been backported to maintenance branches type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

1 participant