Skip to content

Use @SubclassOptInRequired when appropriate #2366

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
Closed
sandwwraith opened this issue Jul 17, 2023 · 1 comment
Closed

Use @SubclassOptInRequired when appropriate #2366

sandwwraith opened this issue Jul 17, 2023 · 1 comment
Assignees
@sandwwraith

Comments

@sandwwraith
Copy link
Member

After 1.9.0 migration

https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-subclass-opt-in-required/
@sandwwraith sandwwraith self-assigned this Jul 17, 2023
sandwwraith added a commit that referenced this issue Aug 7, 2024
@sandwwraith
Stabilize most of SerialDescriptor and SerialKind API
8fc9453 
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental.

Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
sandwwraith added a commit that referenced this issue Aug 7, 2024
@sandwwraith
Introduce @AdvancedEncodingApi and @SealedSerializationApi annotations
3c7da48 
to be used with @SubclassOptInRequired.

These annotations allow for even more fine-grained API marking. We now can designate APIs
as public for use, but closed for implementation (@SealedSerializationApi) — the case for SerialDescriptor, which is a non-sealed interface for technical reasons.

The other annotation, @AdvancedEncodingApi is aimed to provide guidance on implementing custom encoders/decoders by pointing users to a documentation and guides.

Fixes #2366
qwwdfsad pushed a commit that referenced this issue Aug 26, 2024
@sandwwraith @qwwdfsad
Stabilize most of SerialDescriptor and SerialKind API
de1cd59 
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental.

Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
qwwdfsad pushed a commit that referenced this issue Aug 26, 2024
@sandwwraith @qwwdfsad
Introduce @AdvancedEncodingApi and @SealedSerializationApi annotations
14dbaee 
to be used with @SubclassOptInRequired.

These annotations allow for even more fine-grained API marking. We now can designate APIs
as public for use, but closed for implementation (@SealedSerializationApi) — the case for SerialDescriptor, which is a non-sealed interface for technical reasons.

The other annotation, @AdvancedEncodingApi is aimed to provide guidance on implementing custom encoders/decoders by pointing users to a documentation and guides.

Fixes #2366
sandwwraith added a commit that referenced this issue Aug 27, 2024
@sandwwraith
Stabilize most of SerialDescriptor and SerialKind API
8577781 
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental.

Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
sandwwraith added a commit that referenced this issue Aug 27, 2024
@sandwwraith
Introduce @AdvancedEncodingApi and @SealedSerializationApi annotations
5d538ee 
to be used with @SubclassOptInRequired.

These annotations allow for even more fine-grained API marking. We now can designate APIs
as public for use, but closed for implementation (@SealedSerializationApi) — the case for SerialDescriptor, which is a non-sealed interface for technical reasons.

The other annotation, @AdvancedEncodingApi is aimed to provide guidance on implementing custom encoders/decoders by pointing users to a documentation and guides.

Fixes #2366
sandwwraith added a commit that referenced this issue Oct 7, 2024
@sandwwraith
Stabilize most of SerialDescriptor and SerialKind API
4f44bfe 
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental.

Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
sandwwraith added a commit that referenced this issue Oct 9, 2024
@sandwwraith
Stabilize most of SerialDescriptor and SerialKind API
df27589 
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental.

Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
sandwwraith added a commit that referenced this issue Oct 9, 2024
@sandwwraith
Stabilize most of SerialDescriptor and SerialKind API
d2b5727 
This API has been around for a long time and has proven itself useful. The main reason @ExperimentalSerializationApi was on SerialDescriptor's properties is that we wanted to discourage people from subclassing it. With the introduction of @SubclassOptInRequired (#2366), we can do this without the need of marking everything with experimental.

Serial kinds fall into the same category with only exception in PolymorphicKind. There are plenty requests for functionality like creating a custom sealed-like descriptor (#2697, #2721, #1865) which may require additional kinds in the future.
@sandwwraith
Copy link
Member Author

Fixed by #2827. We still may want to introduce @AdvancedEncodingApi later, but the impact on format authors may be big

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sandwwraith sandwwraith

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sandwwraith