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

Refactoring: Use lombok for simple getters & setters #18559

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

Philzen
Copy link
Contributor

@Philzen Philzen commented May 3, 2024

As Lombok is available throughout the project and also used in a couple of places, we can use it to remove several thousand lines of boilerplate code. This PR applies mostly @Getter and @Setter annotations wherever feasible, while not replacing any getter or setter methods that already have annotations (which could be facilitated via the onX meta-annotation, however for now refraining from using it as it is still experimental).

This makes the code base and – most importantly – the cognitive complexity to work through the repo considerably smaller. Also the declarative approach has the advantage that one can see immediately if a field is exposed in the public API by just looking at the declaration annotation.

This PR also contains some Javadoc and @Override annotation fixes and removes identical implementations in inherited classes.


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 correct branch: 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.

@Philzen Philzen force-pushed the change/apply-lombok branch 3 times, most recently from 02ed275 to bad99fe Compare May 3, 2024 01:37
@Philzen Philzen marked this pull request as ready for review May 3, 2024 01:51
@Philzen Philzen requested a review from jimschubert as a code owner May 3, 2024 01:51
@Philzen
Copy link
Contributor Author

Philzen commented May 19, 2024

@wing328 This PR was lying dormant for over two weeks as it appears the automatically assigned reviewer is unavailable. I've now rebased everything on main master – would you be able to take over for a review here?

Would love this to go in first so i can rebase my other open PRs on it (as it greatly simplfies things with ~3500 LOC saved).

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.

None yet

1 participant