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(application): move navigation module interface to api package #432

Merged
merged 1 commit into from
Nov 21, 2024

Conversation

kschrab
Copy link
Contributor

@kschrab kschrab commented Nov 11, 2024

Description

  • In contrast to other unit module interfaces (e.g. perception or communicatin), the navigation related interfaces INavigationModule and IRoutingModule were misplaced inside the implementation package.
  • The interfaces now have been renamed to NavigationModule and RoutingModule and were moved to org.eclipse.mosaic.fed.application.app.api.navigation package to improve consistency.
  • The implementation NavigationModule, which implements both interfaces, has been renamed to RoutingNavigationModule, to 1) avoid name clash with the interface, and 2) to make more clear that it implements both interfaces.
  • The method retrieveAllValidRoutesToTarget(..) has been removed from NavigationModule interface as it was not used and does also makes no sense from a navigation module point of view, as it is more of a helper method for the CentralNavigationComponent. No replacement is offered, as it was not required in any of our existing models.

Issue(s) related to this PR

  • Resolves internal issue 930

Affected parts of the online documentation

Yes, code examples in https://eclipse.dev/mosaic/docs/develop_applications/navigation/ must be adjusted.

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 added the clean-up Aesthetically improving code label Nov 11, 2024
@kschrab kschrab requested a review from rprotzmann November 12, 2024 15:44
@kschrab kschrab force-pushed the 930-move-navigation-module branch from 62050b1 to 18e0c7b Compare November 20, 2024 12:09
@kschrab kschrab force-pushed the 930-move-navigation-module branch from 18e0c7b to d10adf5 Compare November 21, 2024 09:25
@rprotzmann rprotzmann merged commit 6b45c0e into main Nov 21, 2024
5 checks passed
@kschrab kschrab deleted the 930-move-navigation-module branch November 22, 2024 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-up Aesthetically improving code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants