Skip to content
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.

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

[Java] Feat add java builder pattern #18569

Closed
wants to merge 33 commits into from

Conversation

jpfinne
Copy link
Contributor

@jpfinne jpfinne commented May 4, 2024

Fix #18032. Add a new configOptions: generateBuilders to java client and spring generators

The name of the option is the same as in JavaJAXSRSSpecServerCodeGen.

Spring + lombok: generateBuilders + generateConstructorWithAllArgs configOptions can be used instead of lombok.

The builder is not created when lombok.Data is configured (issue with fluent setters not generated)

Improve generation of no args constructor.
Also minor fix for the generateConstructorWithAllArgs and Lombok.AllArgsConstructor (there was some typos)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the 7.0.6 (https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches): master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Please review
@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) @martin-mfg (2023/08)
Java Spring | @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

Jean-Paul Finne and others added 30 commits December 13, 2023 10:22
# Conflicts:
#	modules/openapi-generator-cli/pom.xml
#	modules/openapi-generator-core/pom.xml
#	modules/openapi-generator-gradle-plugin/pom.xml
#	modules/openapi-generator-maven-plugin/pom.xml
#	modules/openapi-generator-online/pom.xml
#	modules/openapi-generator/pom.xml
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
#	pom.xml
# Conflicts:
#	bin/configs/java-okhttp-user-defined-templates.yaml
#	modules/openapi-generator/src/main/resources/php-flight/register_routes.mustache
#	modules/openapi-generator/src/main/resources/php-flight/register_routes_test.mustache
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
#	modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
#	modules/openapi-generator/src/test/resources/3_0/spring/issue_18340.yaml
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/.github/workflows/maven.yml
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/.openapi-generator/FILES
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradle/wrapper/gradle-wrapper.jar
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradle/wrapper/gradle-wrapper.properties
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradlew
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/gradlew.bat
#	samples/client/echo_api/java/okhttp-gson-user-defined-templates/info.md
#	samples/openapi3/client/petstore/python/tests/test_model.py
#	samples/server/petstore/php-flight/RegisterRoutes.php
#	samples/server/petstore/php-flight/Test/RegisterRoutesTest.php
@@ -151,7 +151,7 @@ public class {{classname}}{{#parent}} extends {{{parent}}}{{/parent}}{{^parent}}
{{! begin feature: fluent setter methods }}
public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
{{#openApiNullable}}
this.{{name}} = {{#isNullable}}JsonNullable.of({{/isNullable}}{{#useOptional}}{{^required}}{{^isNullable}}{{^isContainer}}Optional.of({{/isContainer}}{{/isNullable}}{{/required}}{{/useOptional}}{{name}}{{#isNullable}}){{/isNullable}}{{#useOptional}}{{^required}}{{^isNullable}}{{^isContainer}}){{/isContainer}}{{/isNullable}}{{/required}}{{/useOptional}};
this.{{name}} = {{#isNullable}}JsonNullable.of({{/isNullable}}{{#useOptional}}{{^required}}{{^isNullable}}{{^isContainer}}Optional.ofNullable({{/isContainer}}{{/isNullable}}{{/required}}{{/useOptional}}{{name}}{{#isNullable}}){{/isNullable}}{{#useOptional}}{{^required}}{{^isNullable}}{{^isContainer}}){{/isContainer}}{{/isNullable}}{{/required}}{{/useOptional}};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this change required for the builder pattern?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reverted the change.

I will create a new issue for this useOptional flag described as " Use Optional container for optional parameters" .
It creates optional fields that can lead to NullPointerException...
It also makes the mustache template so harder to maintain

@jpfinne jpfinne requested a review from jimschubert as a code owner May 9, 2024 16:51
@wing328
Copy link
Member

wing328 commented May 11, 2024

do you mind filing a new one instead (using the latest master of the official openapi-generator) as some commits do not seem to be related to this change at all?

@jpfinne jpfinne closed this May 12, 2024
@jpfinne jpfinne deleted the featAddJavaBuilderPattern branch May 12, 2024 14:03
@jpfinne
Copy link
Contributor Author

jpfinne commented May 12, 2024

do you mind filing a new one instead (using the latest master of the official openapi-generator) as some commits do not seem to be related to this change at all?

@wing328 See #18648

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] [java] create a builder pattern for the models
2 participants