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.

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

Included custom data field sets are now nullable #324

Closed
2 tasks done
vestrel00 opened this issue Sep 25, 2023 · 2 comments
Closed
2 tasks done

Included custom data field sets are now nullable #324

vestrel00 opened this issue Sep 25, 2023 · 2 comments
Assignees
Labels
breaking change This may break integration of the library for some consumers

Comments

@vestrel00
Copy link
Owner

vestrel00 commented Sep 25, 2023

Problem

Due to changes in #321, the following custom data components now take in nullable custom data field sets (e.g. Set<AbstractCustomDataField>?).

When upgrading to the latest release, library users that define their own custom data will run into compiler errors in implementations of;

  • AbstractCustomDataCursor
  • AbstractCustomDataEntityMapper.Factory
  • AbstractCustomDataOperation
  • AbstractCustomDataOperation.Factory

Solution

Notify library users of this breaking change!

@vestrel00 vestrel00 added the breaking change This may break integration of the library for some consumers label Sep 25, 2023
@vestrel00 vestrel00 self-assigned this Sep 25, 2023
@vestrel00
Copy link
Owner Author

Migration guide (to be included in release notes)

Fix compile errors by making Set<AbstractCustomDataField> nullable -> Set<AbstractCustomDataField>?

For example, change this...

internal class HandleNameMapperFactory {
    override fun create(
        ... includeFields: Set<HandleNameField>
    ) = HandleNameMapper(HandleNameDataCursor(cursor, includeFields))
}

to this...

internal class HandleNameMapperFactory {
    override fun create(
        ... includeFields: Set<HandleNameField>?
    ) = HandleNameMapper(HandleNameDataCursor(cursor, includeFields))
}

@vestrel00
Copy link
Owner Author

This is included in release 0.3.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This may break integration of the library for some consumers
Projects
Development

No branches or pull requests

1 participant