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

refactor(output): cleaner initialization of output generators #403

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

kschrab
Copy link
Contributor

@kschrab kschrab commented Aug 13, 2024

Description

  • Previously, implementations of OutputGenerator had to override the initialize method and were required to call super.initialize, which is a anti-pattern to avoid.
  • This MR marks initialize as a final method and defines an additional abstract configure method which all subclasses need to implement to read additional parameters from the output generator configuration.

Issue(s) related to this PR

  • Resolves internal issue 875

Affected parts of the online documentation

Changes in the documentation required?

No

Definition of Done

Prerequisites

  • You have read CONTRIBUTING.md carefully.
  • You have signed the Contributor License Agreement.
  • Your GitHub user id is linked with your Eclipse Account.

Required

  • The title of this merge request follows the scheme type(scope): description (in the style of Conventional Commits)
  • You have assigned a suitable label to this pull request (e.g., enhancement, or bugfix)
  • origin/main has been merged into your Fork.
  • Coding guidelines have been followed (see CONTRIBUTING.md).
  • All checks on GitHub pass.
  • All tests on Jenkins pass.

Requested (can be enforced by maintainers)

  • New functionality is covered by unit tests or integration tests. Code coverage must not decrease.
  • If a bug has been fixed, a new unit test has been written (beforehand) to prove misbehavior
  • There are no new SpotBugs warnings.

Special notes to reviewer

@kschrab kschrab requested a review from schwepmo August 13, 2024 16:24
@kschrab kschrab assigned kschrab and unassigned schwepmo Aug 13, 2024
Copy link
Contributor

@schwepmo schwepmo left a comment

Choose a reason for hiding this comment

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

LGTM, this is a way nicer solution!

@schwepmo schwepmo merged commit a991ae4 into main Aug 16, 2024
6 checks passed
@schwepmo schwepmo deleted the 875-output-generator-init branch August 16, 2024 14:07
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.

2 participants