Fix `addEntities()` and `addFromCollection()` generic parameter #225

fpotier · 2025-02-27T13:18:44Z

Because of java type erasure on generics this code doesn't compile even though DataEntity inherits from AbstractEntity:

RoCrate crate = new RoCrate();
Collection<DataEntity> entities = new ArrayList<>();
crate.addFromCollection(entities);

This patch makes it possible to add a collection of AbstractEntity or any class that inherits from it.

Summary by CodeRabbit

Refactor
- Enhanced how the system handles collections of entity types, now accommodating a wider variety of entity subtypes for increased flexibility.

coderabbitai · 2025-02-27T13:18:51Z

Walkthrough

The changes update method signatures in several files to accept a broader type. The methods in both the Crate/RoCrate and CratePayload/RoCratePayload interfaces and classes now use Collection<? extends AbstractEntity> instead of Collection<AbstractEntity>. This adjustment allows collections containing subtypes of AbstractEntity to be passed in. The internal logic remains unchanged, with only the accepted parameter types modified to improve flexibility.

Changes

File(s)	Change Summary
`src/.../ro_crate/Crate.java` `src/.../ro_crate/RoCrate.java`	Updated `addFromCollection` signature from `Collection<AbstractEntity>` to `Collection<? extends AbstractEntity>`.
`src/.../ro_crate/payload/CratePayload.java` `src/.../ro_crate/payload/RoCratePayload.java`	Updated `addEntities` signature from `Collection<AbstractEntity>` to `Collection<? extends AbstractEntity>`.

Poem

I hop through lines of code so bright,
Changing signatures by day and night.
My methods now embrace each friendly subtype,
A small tweak that makes code sublime.
With every hop, I celebrate this update—oh, what a delight! 🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 16bfa42 and fc355cb.

📒 Files selected for processing (4)

src/main/java/edu/kit/datamanager/ro_crate/Crate.java (1 hunks)
src/main/java/edu/kit/datamanager/ro_crate/RoCrate.java (1 hunks)
src/main/java/edu/kit/datamanager/ro_crate/payload/CratePayload.java (1 hunks)
src/main/java/edu/kit/datamanager/ro_crate/payload/RoCratePayload.java (1 hunks)

🔇 Additional comments (4)

src/main/java/edu/kit/datamanager/ro_crate/payload/CratePayload.java (1)

33-33: Excellent improvement to method signature flexibility.

Changing the method signature to use Collection<? extends AbstractEntity> instead of Collection<AbstractEntity> is a good approach. This change allows collections of subtypes of AbstractEntity (such as DataEntity or other subclasses) to be passed to this method, addressing the Java type erasure issue mentioned in the PR objectives.

src/main/java/edu/kit/datamanager/ro_crate/Crate.java (1)

87-87: Good consistent use of bounded wildcard.

Using Collection<? extends AbstractEntity> in the interface definition ensures the API can accept collections of any AbstractEntity subtype. This matches the changes in the CratePayload interface and maintains consistency across the codebase.

src/main/java/edu/kit/datamanager/ro_crate/RoCrate.java (1)

232-232: Implementation correctly matches interface change.

The implementation now accepts a broader range of collection types while maintaining type safety. This works well with the downstream call to roCratePayload.addEntities() since that method has been updated with the same signature.

src/main/java/edu/kit/datamanager/ro_crate/payload/RoCratePayload.java (1)

80-80: Well-implemented method signature change.

The implementation now properly accepts Collection<? extends AbstractEntity> while maintaining the same logic internally. Since the iteration only accesses methods available on the base AbstractEntity class, this change is type-safe while providing the flexibility needed to solve the compilation issue mentioned in the PR description.

✨ Finishing Touches

📝 Generate Docstrings

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Pfeil · 2025-03-14T13:20:26Z

Confirmed the issue, as well as the fix. Thanks! This will make it in the next release, probably next week when I merged a few other things that are still open.

Pfeil · 2025-03-17T10:59:05Z

(Note: This has been released in v2.0.2)

fpotier · 2025-03-18T08:17:06Z

Thank you!

Make addEntities addFromCollection more generic

fc355cb

fpotier changed the title ~~Make addEntities addFromCollection more generic~~ Fix addEntities() and addFromCollection() generic parameter Feb 27, 2025

Pfeil approved these changes Mar 14, 2025

View reviewed changes

Pfeil merged commit 5ecc98f into kit-data-manager:main Mar 14, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix `addEntities()` and `addFromCollection()` generic parameter #225

Fix `addEntities()` and `addFromCollection()` generic parameter #225

Uh oh!

fpotier commented Feb 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 27, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Pfeil commented Mar 14, 2025

Uh oh!

Uh oh!

Pfeil commented Mar 17, 2025

Uh oh!

fpotier commented Mar 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix addEntities() and addFromCollection() generic parameter #225

Fix addEntities() and addFromCollection() generic parameter #225

Uh oh!

Conversation

fpotier commented Feb 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Pfeil commented Mar 14, 2025

Uh oh!

Uh oh!

Pfeil commented Mar 17, 2025

Uh oh!

fpotier commented Mar 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix `addEntities()` and `addFromCollection()` generic parameter #225

Fix `addEntities()` and `addFromCollection()` generic parameter #225

fpotier commented Feb 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)