[jira] [Updated] (SLING-7798) Switch from JSR-305 annotations to JetBrains Nullable/NotNull annotations

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Updated] (SLING-7798) Switch from JSR-305 annotations to JetBrains Nullable/NotNull annotations

JIRA jira@apache.org

     [ https://issues.apache.org/jira/browse/SLING-7798?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Oliver Lietz updated SLING-7798:
--------------------------------
    Description:
follow-up from SLING-7312 and discussion from the [mailing list|https://lists.apache.org/thread.html/44cac2f3c9454a308b70adb9c73a8e9a928d9c145a12f82f8a3a0ef1@%3Cdev.sling.apache.org%3E].
 i will also start a vote on the mailing list about this, but this ticket describes the steps that are required.

about the jetbrains annotations:
 * documentation: [https://www.jetbrains.com/help/idea/nullable-and-notnull-annotations.html]
 * artifact: [http://repo1.maven.org/maven2/org/jetbrains/annotations/16.0.2/]
 * although from jetbrans created for IntelliJ, they are also support by most other tooling (e.g. findbugs, sonar, configurable in Eclipse)
 * apache 2.0 licensed: [https://github.com/JetBrains/java-annotations]

this search turned out that these modules are currently using JSR-305 annotations and need to be converted:
||Module||Switch||Released||
|org-apache-sling-api|(/)| (/)|
|org-apache-sling-auth-core|(/) removed unused dependency| -|
|org-apache-sling-caconfig-api|(/)| (/)|
|org-apache-sling-caconfig-impl|(/)| (/)|
|org-apache-sling-caconfig-spi|(/)| (/)|
|org-apache-sling-commons-clam|(/)| (/)|
|org-apache-sling-commons-messaging|(/) no release yet| -|
|org-apache-sling-commons-messaging-mail|(/) no release yet| -|
|org-apache-sling-discovery-commons|(/)| (x)|
|org-apache-sling-distribution-api|(/)| (x)|
|org-apache-sling-distribution-avro-serializer|(/) no release yet| -|
|org-apache-sling-distribution-core|(/) unit test fails (already before)| (/)|
|org-apache-sling-distribution-kryo-serializer|(/) no release yet| -|
|org-apache-sling-installer-core|(/)| (/)|
|org-apache-sling-jcr-api|(/)| (x)|
|org-apache-sling-jcr-resource|(/)| (/)|
|org-apache-sling-jms|(/)| (x)|
|org-apache-sling-jobs|(/)| (x)|
|org-apache-sling-jobs-it-services|(/) no release required| -|
|org-apache-sling-models-api|(/)| (x)|
|org-apache-sling-models-impl|(/)| (x)|
|org-apache-sling-models-jacksonexporter|(/)| (x)|
|org-apache-sling-models-validation-impl|(/) no release yet| -|
|org-apache-sling-mom|(/)| (x)|
|org-apache-sling-oak-restrictions|(/)| (x)|
|org-apache-sling-resource-presence|(/)| (x)|
|org-apache-sling-resourceresolver|(/)| (/)|
|org-apache-sling-scripting-core|(/)| (x)|
|org-apache-sling-scripting-sightly|(/)| (x)|
|org-apache-sling-scripting-thymeleaf|(/)| (/)|
|org-apache-sling-tracer|(/)| (x)|
|org-apache-sling-validation-api|(/)| (x)|
|org-apache-sling-validation-core|(/)| (x)|
|org-apache-sling-validation-test-services|(/) no release required| -|
|org-apache-sling-xss|(/)| (x)|
|parent|(/)| (/)|
|whiteboard/encrypt|(/) no release required| -|
|whiteboard/project-archetype/src/main/resources/archetype-resources|(/) no release required| -|
|whiteboard/scripting-resolver/org-apache-sling-scripting-resolver|(/) no release required| -|

steps to do:
 # convert java sources and poms to jetbrains annotations and update package versions with the help of the {{convert-annotations.sh}} from OAK-7511 provided by [~reschke] described here
 # update sling documentation: [https://sling.apache.org/documentation/development/jsr-305.html]

  was:
follow-up from SLING-7312 and discussion from the [mailing list|https://lists.apache.org/thread.html/44cac2f3c9454a308b70adb9c73a8e9a928d9c145a12f82f8a3a0ef1@%3Cdev.sling.apache.org%3E].
 i will also start a vote on the mailing list about this, but this ticket describes the steps that are required.

about the jetbrains annotations:
 * documentation: [https://www.jetbrains.com/help/idea/nullable-and-notnull-annotations.html]
 * artifact: [http://repo1.maven.org/maven2/org/jetbrains/annotations/16.0.2/]
 * although from jetbrans created for IntelliJ, they are also support by most other tooling (e.g. findbugs, sonar, configurable in Eclipse)
 * apache 2.0 licensed: [https://github.com/JetBrains/java-annotations]

this search turned out that these modules are currently using JSR-305 annotations and need to be converted:
||Module||Switch||Released||
|org-apache-sling-api|(/)| (/)|
|org-apache-sling-auth-core|(/) removed unused dependency| -|
|org-apache-sling-caconfig-api|(/)| (/)|
|org-apache-sling-caconfig-impl|(/)| (/)|
|org-apache-sling-caconfig-spi|(/)| (/)|
|org-apache-sling-commons-clam|(/) no release yet| -|
|org-apache-sling-commons-messaging|(/) no release yet| -|
|org-apache-sling-commons-messaging-mail|(/) no release yet| -|
|org-apache-sling-discovery-commons|(/)| (x)|
|org-apache-sling-distribution-api|(/)| (x)|
|org-apache-sling-distribution-avro-serializer|(/) no release yet| -|
|org-apache-sling-distribution-core|(/) unit test fails (already before)| (/)|
|org-apache-sling-distribution-kryo-serializer|(/) no release yet| -|
|org-apache-sling-installer-core|(/)| (/)|
|org-apache-sling-jcr-api|(/)| (x)|
|org-apache-sling-jcr-resource|(/)| (/)|
|org-apache-sling-jms|(/)| (x)|
|org-apache-sling-jobs|(/)| (x)|
|org-apache-sling-jobs-it-services|(/) no release required| -|
|org-apache-sling-models-api|(/)| (x)|
|org-apache-sling-models-impl|(/)| (x)|
|org-apache-sling-models-jacksonexporter|(/)| (x)|
|org-apache-sling-models-validation-impl|(/) no release yet| -|
|org-apache-sling-mom|(/)| (x)|
|org-apache-sling-oak-restrictions|(/)| (x)|
|org-apache-sling-resource-presence|(/)| (x)|
|org-apache-sling-resourceresolver|(/)| (/)|
|org-apache-sling-scripting-core|(/)| (x)|
|org-apache-sling-scripting-sightly|(/)| (x)|
|org-apache-sling-scripting-thymeleaf|(/)| (x)|
|org-apache-sling-tracer|(/)| (x)|
|org-apache-sling-validation-api|(/)| (x)|
|org-apache-sling-validation-core|(/)| (x)|
|org-apache-sling-validation-test-services|(/) no release required| -|
|org-apache-sling-xss|(/)| (x)|
|parent|(/)| (/)|
|whiteboard/encrypt|(/) no release required| -|
|whiteboard/project-archetype/src/main/resources/archetype-resources|(/) no release required| -|
|whiteboard/scripting-resolver/org-apache-sling-scripting-resolver|(/) no release required| -|

steps to do:
 # convert java sources and poms to jetbrains annotations and update package versions with the help of the {{convert-annotations.sh}} from OAK-7511 provided by [~reschke] described here
 # update sling documentation: [https://sling.apache.org/documentation/development/jsr-305.html]


> Switch from JSR-305 annotations to JetBrains Nullable/NotNull annotations
> --------------------------------------------------------------------------
>
>                 Key: SLING-7798
>                 URL: https://issues.apache.org/jira/browse/SLING-7798
>             Project: Sling
>          Issue Type: Improvement
>          Components: General
>            Reporter: Stefan Seifert
>            Assignee: Stefan Seifert
>            Priority: Major
>             Fix For: JCR API 2.4.2, Auth Core 1.4.4, API 2.18.4, Sling Models API 1.3.8, Content Distribution Core 0.3.0, Content Distribution API 0.4.0, Validation API 1.0.2, Sling Models Validation Impl 1.0.0, Log Tracer 1.0.8, Commons Messaging 1.0.0, Commons Messaging Mail 1.0.0, Scripting Thymeleaf 2.0.0, Oak Restrictions 1.0.2, Context-Aware Configuration API 1.1.2, MoM API 1.0.2, MoM JMS 1.0.2, MoM Jobs 1.0.2, Resource Presence 0.0.4, Discovery Commons 1.0.24, Context-Aware Configuration SPI 1.3.4, Sling Models Jackson Exporter 1.0.10, Validation Core 1.0.6, Parent 34, Scripting Core 2.0.56, Installer Core 3.9.0, Sling Models Impl 1.4.10, Context-Aware Configuration Impl 1.4.14, Commons Clam 1.0.0, Resource Resolver 1.6.6, JCR Resource 3.0.16, XSS Protection API 2.0.14, Scripting HTL Engine 1.0.56-1.4.0
>
>
> follow-up from SLING-7312 and discussion from the [mailing list|https://lists.apache.org/thread.html/44cac2f3c9454a308b70adb9c73a8e9a928d9c145a12f82f8a3a0ef1@%3Cdev.sling.apache.org%3E].
>  i will also start a vote on the mailing list about this, but this ticket describes the steps that are required.
> about the jetbrains annotations:
>  * documentation: [https://www.jetbrains.com/help/idea/nullable-and-notnull-annotations.html]
>  * artifact: [http://repo1.maven.org/maven2/org/jetbrains/annotations/16.0.2/]
>  * although from jetbrans created for IntelliJ, they are also support by most other tooling (e.g. findbugs, sonar, configurable in Eclipse)
>  * apache 2.0 licensed: [https://github.com/JetBrains/java-annotations]
> this search turned out that these modules are currently using JSR-305 annotations and need to be converted:
> ||Module||Switch||Released||
> |org-apache-sling-api|(/)| (/)|
> |org-apache-sling-auth-core|(/) removed unused dependency| -|
> |org-apache-sling-caconfig-api|(/)| (/)|
> |org-apache-sling-caconfig-impl|(/)| (/)|
> |org-apache-sling-caconfig-spi|(/)| (/)|
> |org-apache-sling-commons-clam|(/)| (/)|
> |org-apache-sling-commons-messaging|(/) no release yet| -|
> |org-apache-sling-commons-messaging-mail|(/) no release yet| -|
> |org-apache-sling-discovery-commons|(/)| (x)|
> |org-apache-sling-distribution-api|(/)| (x)|
> |org-apache-sling-distribution-avro-serializer|(/) no release yet| -|
> |org-apache-sling-distribution-core|(/) unit test fails (already before)| (/)|
> |org-apache-sling-distribution-kryo-serializer|(/) no release yet| -|
> |org-apache-sling-installer-core|(/)| (/)|
> |org-apache-sling-jcr-api|(/)| (x)|
> |org-apache-sling-jcr-resource|(/)| (/)|
> |org-apache-sling-jms|(/)| (x)|
> |org-apache-sling-jobs|(/)| (x)|
> |org-apache-sling-jobs-it-services|(/) no release required| -|
> |org-apache-sling-models-api|(/)| (x)|
> |org-apache-sling-models-impl|(/)| (x)|
> |org-apache-sling-models-jacksonexporter|(/)| (x)|
> |org-apache-sling-models-validation-impl|(/) no release yet| -|
> |org-apache-sling-mom|(/)| (x)|
> |org-apache-sling-oak-restrictions|(/)| (x)|
> |org-apache-sling-resource-presence|(/)| (x)|
> |org-apache-sling-resourceresolver|(/)| (/)|
> |org-apache-sling-scripting-core|(/)| (x)|
> |org-apache-sling-scripting-sightly|(/)| (x)|
> |org-apache-sling-scripting-thymeleaf|(/)| (/)|
> |org-apache-sling-tracer|(/)| (x)|
> |org-apache-sling-validation-api|(/)| (x)|
> |org-apache-sling-validation-core|(/)| (x)|
> |org-apache-sling-validation-test-services|(/) no release required| -|
> |org-apache-sling-xss|(/)| (x)|
> |parent|(/)| (/)|
> |whiteboard/encrypt|(/) no release required| -|
> |whiteboard/project-archetype/src/main/resources/archetype-resources|(/) no release required| -|
> |whiteboard/scripting-resolver/org-apache-sling-scripting-resolver|(/) no release required| -|
> steps to do:
>  # convert java sources and poms to jetbrains annotations and update package versions with the help of the {{convert-annotations.sh}} from OAK-7511 provided by [~reschke] described here
>  # update sling documentation: [https://sling.apache.org/documentation/development/jsr-305.html]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)