[java] [Spring] useJspecify for java clients and spring generator (#23256)

* useJspecify for java clients and spring generator

* Merge master

* Regenerate documentation

* Remove ignore file

* Doc only for JavaClientCodegen and SpringCodeGen

* Regenerate

* Simplification of JSpecify implementation

* Fix typo "Only supported"

* Fix documentation formatting

* Fix documentation formatting

* Fix extra spaces

* Merge master

* Fix spacing for Spring generator

* Merge master

* Merge master

* Add samples to github flow

* Try to rebuild samples on gitFlow

* git update-index --chmod=+x samples/client/petstore/java/native-jackson3-jspecify/gradlew

* Add jspecify to build.gradle

* Add jspecify to build.gradle in dependencies {

* conditionally include jspecify dependencies

* merge master

* Simplify spacing

* Fix native request builder

* Some cleanup and comments

* Some cleanup

---------

Co-authored-by: jpfinne <jean-paul.finne@fednot.be>

Author: jpfinne

.github/workflows/samples-java-client-jdk17.yaml

@@ -8,6 +8,8 @@ on:
       - samples/client/petstore/java/webclient-jakarta/**
       - samples/client/petstore/java/restclient-*/**
       - samples/client/petstore/java/native-jackson3/**
+      - samples/client/petstore/java/native-jackson3-jspecify/**
+      - samples/client/petstore/java/restclient-springBoot4-jackson3-jspecify/**
       - samples/client/others/java/webclient-sealedInterface/**
       - samples/client/others/java/webclient-sealedInterface_3_1/**
       - samples/client/petstore/java/webclient-useSingleRequestParameter/**
@@ -21,6 +23,8 @@ on:
       - samples/client/petstore/java/webclient-jakarta/**
       - samples/client/petstore/java/restclient-*/**
       - samples/client/petstore/java/native-jackson3/**
+      - samples/client/petstore/java/native-jackson3-jspecify/**
+      - samples/client/petstore/java/restclient-springBoot4-jackson3-jspecify/**
       - samples/client/others/java/webclient-sealedInterface/**
       - samples/client/others/java/webclient-sealedInterface_3_1/**
       - samples/client/petstore/java/webclient-useSingleRequestParameter/**
@@ -44,6 +48,8 @@ jobs:
           - samples/client/petstore/java/restclient-nullable-arrays
           - samples/client/petstore/java/restclient-springBoot4-jackson2
           - samples/client/petstore/java/restclient-springBoot4-jackson3
+          - samples/client/petstore/java/restclient-springBoot4-jackson3-jspecify
+          - samples/client/petstore/java/native-jackson3-jspecify
           - samples/client/petstore/java/restclient-swagger2
           - samples/client/petstore/java/restclient-useSingleRequestParameter
           - samples/client/petstore/java/restclient-useSingleRequestParameter-static

.github/workflows/samples-spring-jdk17.yaml

@@ -8,6 +8,7 @@ on:
       - samples/client/petstore/spring-http-interface-springboot-4/**
       - samples/openapi3/server/petstore/springboot-3/**
       - samples/openapi3/server/petstore/springboot-4/**
+      - samples/openapi3/server/petstore/springboot-4-jspecify/**
       - samples/server/petstore/springboot-api-response-examples/**
       - samples/server/petstore/springboot-lombok-data/**
       - samples/server/petstore/springboot-lombok-tostring/**
@@ -22,6 +23,7 @@ on:
       - samples/client/petstore/spring-http-interface-springboot-4/**
       - samples/openapi3/server/petstore/springboot-3/**
       - samples/openapi3/server/petstore/springboot-4/**
+      - samples/openapi3/server/petstore/springboot-4-jspecify/**
       - samples/server/petstore/springboot-api-response-examples/**
       - samples/server/petstore/springboot-lombok-data/**
       - samples/server/petstore/springboot-lombok-tostring/**
@@ -44,6 +46,7 @@ jobs:
           # servers
           - samples/openapi3/server/petstore/springboot-3
           - samples/openapi3/server/petstore/springboot-4
+          - samples/openapi3/server/petstore/springboot-4-jspecify
           - samples/server/petstore/springboot-api-response-examples
           - samples/server/petstore/springboot-lombok-data
           - samples/server/petstore/springboot-lombok-tostring

bin/configs/java-native-jackson3-jspecify.yaml

@@ -0,0 +1,17 @@
+generatorName: java
+outputDir: samples/client/petstore/java/native-jackson3-jspecify
+library: native
+inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+validateSpec: false
+additionalProperties:
+  artifactId: petstore-native-jackson3
+  hideGenerationTimestamp: "true"
+  generateBuilders: true
+  useReflectionEqualsHashCode: "true"
+  useJackson3: "true"
+  openApiNullable: "false"
+  useJspecify: true
+typeMappings:
+  OffsetDateTime: java.time.Instant
+  BigDecimal: java.math.BigDecimal

bin/configs/java-restclient-springBoot4-jackson3-jspecify.yaml

@@ -0,0 +1,17 @@
+generatorName: java
+outputDir: samples/client/petstore/java/restclient-springBoot4-jackson3-jspecify
+library: restclient
+inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+validateSpec: false
+additionalProperties:
+  artifactId: petstore-restclient
+  hideGenerationTimestamp: "true"
+  containerDefaultToNull: "true"
+  useSpringBoot4: true
+  useJackson3: true
+  openApiNullable: false
+  useJspecify: true
+typeMappings:
+  OffsetDateTime: java.time.Instant
+  BigDecimal: java.math.BigDecimal

bin/configs/java-resttemplate-springBoot4-jackson3-jspecify.yaml

@@ -0,0 +1,18 @@
+generatorName: java
+outputDir: samples/client/petstore/java/resttemplate-springBoot4-jackson3-jspecify
+library: resttemplate
+inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+validateSpec: false
+additionalProperties:
+  artifactId: petstore-resttemplate
+  hideGenerationTimestamp: "true"
+  containerDefaultToNull: "true"
+  useJakartaEe: true
+  useSpringBoot4: true
+  useJackson3: true
+  openApiNullable: false
+  useJspecify: true
+typeMappings:
+  OffsetDateTime: java.time.Instant
+  BigDecimal: java.math.BigDecimal

bin/configs/java-webclient-springBoot4-jackson3-jspecify.yaml

@@ -0,0 +1,17 @@
+generatorName: java
+outputDir: samples/client/petstore/java/webclient-springBoot4-jackson3-jspecify
+library: webclient
+inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+validateSpec: false
+additionalProperties:
+  artifactId: petstore-webclient
+  hideGenerationTimestamp: "true"
+  containerDefaultToNull: "true"
+  useSpringBoot4: true
+  useJackson3: true
+  openApiNullable: false
+  useJspecify: true
+typeMappings:
+  OffsetDateTime: java.time.Instant
+  BigDecimal: java.math.BigDecimal

bin/configs/spring-boot-4-jspecify.yaml

@@ -0,0 +1,21 @@
+generatorName: spring
+library: spring-boot
+outputDir: samples/openapi3/server/petstore/springboot-4-jspecify
+inputSpec: modules/openapi-generator/src/test/resources/3_0/java/jspecify.yaml
+templateDir: modules/openapi-generator/src/main/resources/JavaSpring
+validateSpec: false
+additionalProperties:
+  groupId: org.openapitools.openapi3
+  documentationProvider: springdoc
+  interfaceOnly: true
+  artifactId: springboot
+  snapshotVersion: "true"
+  useSpringBoot4: true
+  useJackson3: true
+  useBeanValidation: true
+  withXml: true
+  hideGenerationTimestamp: "true"
+  generateConstructorWithAllArgs: true
+  generateBuilders: true
+  openApiNullable: false
+  useJspecify: true

docs/generators/java-camel.md

@@ -112,6 +112,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useHttpServiceProxyFactoryInterfacesConfigurator|Generate HttpInterfacesAbstractConfigurator based on an HttpServiceProxyFactory instance (as opposed to a WebClient instance, when disabled) for generating Spring HTTP interfaces.| |false|
 |useJackson3|Set it in order to use jackson 3 dependencies (only allowed when `useSpringBoot4` is set).| |false|
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
+|useJspecify|Use Jspecify for null checks| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |true|
 |useOptional|Use Optional container for optional parameters| |false|
 |useResponseEntity|Use the `ResponseEntity` type to wrap return values of generated API methods. If disabled, method are annotated using a `@ResponseStatus` annotation, which has the status of the first response declared in the Api definition| |true|

docs/generators/java-microprofile.md

@@ -99,6 +99,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useGzipFeature|Send gzip-encoded requests| |false|
 |useJackson3|Use Jackson 3 instead of Jackson 2. Supported for 'native' library (requires Java 17+) and for Spring 'resttemplate', 'webclient', and 'restclient' libraries (require useSpringBoot4=true). Incompatible with 'openApiNullable'.| |false|
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
+|useJspecify|Use Jspecify for null checks. Only supported for [native, restclient, resttemplate, webclient]| |false|
 |useOneOfDiscriminatorLookup|Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. Only jersey2, jersey3, native, okhttp-gson support this option.| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |usePlayWS|Use Play! Async HTTP client (Play WS API)| |false|

docs/generators/java.md

@@ -99,6 +99,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |useGzipFeature|Send gzip-encoded requests| |false|
 |useJackson3|Use Jackson 3 instead of Jackson 2. Supported for 'native' library (requires Java 17+) and for Spring 'resttemplate', 'webclient', and 'restclient' libraries (require useSpringBoot4=true). Incompatible with 'openApiNullable'.| |false|
 |useJakartaEe|whether to use Jakarta EE namespace instead of javax| |false|
+|useJspecify|Use Jspecify for null checks. Only supported for [native, restclient, resttemplate, webclient]| |false|
 |useOneOfDiscriminatorLookup|Use the discriminator's mapping in oneOf to speed up the model lookup. IMPORTANT: Validation (e.g. one and only one match in oneOf's schemas) will be skipped. Only jersey2, jersey3, native, okhttp-gson support this option.| |false|
 |useOneOfInterfaces|whether to use a java interface to describe a set of oneOf options, where each option is a class that implements the interface| |false|
 |usePlayWS|Use Play! Async HTTP client (Play WS API)| |false|