[jaxrs-cxf-cdi] mark deprecated api methods#11755
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Mar 1, 2022
Merged
[jaxrs-cxf-cdi] mark deprecated api methods#11755wing328 merged 1 commit intoOpenAPITools:masterfrom
wing328 merged 1 commit intoOpenAPITools:masterfrom
Conversation
26e6cc2 to
bf5a312
Compare
In the generated java code, it is usefull to have the generated java api use the @deprecated annotation. This enable to leverage this annotation at runtime to trigger specific logging for instance. In the generated interface, use the @deprecated annotation. Also, in the jax-rs implementation that links the jax-rs api with the cdi bean implementing the interface, use the @SuppressWarnings("deprecation") annotation. This way the deprecation warning is not shown in generated code. One can use the interface as before: the java compiler can then tell which implementations do implement a deprecated api, using a warning. If the implementation itself also sets the @deprecated annotation, then there is no warning, unless the implementation is called at another place in the code.
Member
|
LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the generated java code, it is usefull to have the generated java api
use the @deprecated annotation. This enable to leverage this annotation
at runtime to trigger specific logging for instance.
In the generated interface, use the @deprecated annotation.
Also, in the jax-rs implementation that links the jax-rs api with the
cdi bean implementing the interface, use the
@SuppressWarnings("deprecation") annotation. This way the deprecation
warning is not shown in generated code.
One can use the interface as before: the java compiler can then tell
which implementations do implement a deprecated api, using a warning.
If the implementation itself also sets the @deprecated annotation, then
there is no warning, unless the implementation is called at another
place in the code.
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master(5.3.0),6.0.xcc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)