Rename JavaPackage.getAllClasses() -> getClassesInPackageTree()
#968
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hankem
approved these changes
Oct 3, 2022
archunit/src/main/java/com/tngtech/archunit/core/domain/JavaPackage.java
Outdated
Show resolved
Hide resolved
In all other places we have replaced the fuzzy word "all" by "in package tree" to clarify the semantics. The Javadoc already hinted at the fact that this method name should be consolidated. Now with release 1.0.0 we can break the API and don't need to deprecate the old method. I decided to call the method `getClassesInPackageTree()`, even though the similar method `getSubpackagesInTree()` does not add the infix "package", because I think for the former it is worth it to clarify the context, while the latter already talks about packages, so "tree" is already clear from the context. Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
codecholeric
force-pushed
the
consolidate-JavaPackage-methods
branch
from
7d2e681
to
7b31072
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In all other places we have replaced the fuzzy word "all" by "in package tree" to clarify the semantics. The Javadoc already hinted at the fact that this method name should be consolidated. Now with release 1.0.0 we can break the API and don't need to deprecate the old method. I decided to call the method
getClassesInPackageTree(), even though the similar methodgetSubpackagesInTree()does not add the infix "package", because I think for the former it is worth it to clarify the context, while the latter already talks about packages, so "tree" is already clear from the context.