[JAVA-5020] Replace @Evolving with @Sealed where appropriate and possible Created: 09/Jun/23  Updated: 16/Jun/23  Resolved: 16/Jun/23

Status: Closed
Project: Java Driver
Component/s: API
Affects Version/s: None
Fix Version/s: 4.10.0

Type: Improvement Priority: Minor - P4
Reporter: Valentin Kavalenka Assignee: Valentin Kavalenka
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Backwards Compatibility: Fully Compatible
Documentation Changes: Needed
Documentation Changes Summary:

Let's mention in the What's new that the interfaces in com.mongodb.client.model.search API are now marked as `@Sealed` instead of being `@Evolving`.

This change would have been breaking if the interfaces were not also marked with `@Beta`, but they are.


 Description   

It makes sense for interfaces like MongoClient to be @Evolving, while for interfaces like SearchOptions @Sealed is a more appropriate annotation. Note also that replacing @Sealed with @Evolving is a backward-compatible change, while the opposite is not. See the doc changes in the linked PR for more details.



 Comments   
Comment by Githook User [ 16/Jun/23 ]

Author:

{'name': 'Valentin Kovalenko', 'email': 'valentin.kovalenko@mongodb.com', 'username': 'stIncMale'}

Message: Replace `@Evolving` with `@Sealed` where appropriate (#1141)

JAVA-5020
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/0f68e1e297dde976ca1417666ad397ecd066b92d

Generated at Thu Feb 08 09:03:32 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.