Skip to content

Commit

Permalink
rename JavaPackage.getAllClasses() -> getClassesInPackageTree()
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
codecholeric committed Oct 3, 2022
1 parent 6878f49 commit 7b31072
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 11 deletions.
Expand Up @@ -303,21 +303,22 @@ private void setParent(JavaPackage parent) {
}

/**
* @return all classes directly contained in this package, but not classes in the lower levels of the package tree (compare {@link #getAllClasses()})
* @return all classes directly contained in this package, but not classes in the lower levels of the package tree (compare {@link #getClassesInPackageTree()})
*/
@PublicAPI(usage = ACCESS)
public Set<JavaClass> getClasses() {
return classes;
}

/**
* @return all classes contained in this package tree (compare {@link #getClasses()})
* @return all classes contained in this {@link JavaPackage package tree}, i.e. all classes in this package,
* subpackages, subpackages of subpackages, and so on (compare {@link #getClasses()})
*/
@PublicAPI(usage = ACCESS)
public Set<JavaClass> getAllClasses() {
public Set<JavaClass> getClassesInPackageTree() {
ImmutableSet.Builder<JavaClass> result = ImmutableSet.<JavaClass>builder().addAll(classes);
for (JavaPackage subpackage : getSubpackages()) {
result.addAll(subpackage.getAllClasses());
result.addAll(subpackage.getClassesInPackageTree());
}
return result.build();
}
Expand Down Expand Up @@ -512,7 +513,7 @@ private static Set<Dependency> getClassDependenciesFrom(Set<JavaClass> classes)
*/
@PublicAPI(usage = ACCESS)
public Set<Dependency> getClassDependenciesFromThisPackageTree() {
return getClassDependenciesFrom(getAllClasses());
return getClassDependenciesFrom(getClassesInPackageTree());
}

/**
Expand Down Expand Up @@ -541,7 +542,7 @@ private static ImmutableSet<Dependency> getClassDependenciesTo(Set<JavaClass> cl
*/
@PublicAPI(usage = ACCESS)
public Set<Dependency> getClassDependenciesToThisPackageTree() {
return getClassDependenciesTo(getAllClasses());
return getClassDependenciesTo(getClassesInPackageTree());
}

/**
Expand Down
Expand Up @@ -121,7 +121,7 @@ public static <T> MetricsComponents<T> from(Collection<T> elements, Function<? s
public static MetricsComponents<JavaClass> fromPackages(Collection<JavaPackage> packages) {
ImmutableSet.Builder<MetricsComponent<JavaClass>> components = ImmutableSet.builder();
for (JavaPackage javaPackage : packages) {
components.add(MetricsComponent.of(javaPackage.getName(), javaPackage.getAllClasses()));
components.add(MetricsComponent.of(javaPackage.getName(), javaPackage.getClassesInPackageTree()));
}
return MetricsComponents.of(components.build());
}
Expand Down
Expand Up @@ -40,14 +40,14 @@ public void restriction_on_classes_should_keep_the_original_package_tree() {
public void creation_of_JavaClasses_from_existing_classes_should_keep_the_original_package_tree() {
JavaClasses classes = JavaClasses.of(singletonList(ALL_CLASSES.get(SomeClass.class)));

assertThat(classes.getDefaultPackage().getAllClasses()).hasSameElementsAs(ALL_CLASSES.getDefaultPackage().getAllClasses());
assertThat(classes.getDefaultPackage().getClassesInPackageTree()).hasSameElementsAs(ALL_CLASSES.getDefaultPackage().getClassesInPackageTree());
}

@Test
public void creation_of_JavaClasses_from_empty_classes_should_create_empty_default_package() {
JavaClasses classes = JavaClasses.of(emptySet());

assertThat(classes.getDefaultPackage().getAllClasses()).isEmpty();
assertThat(classes.getDefaultPackage().getClassesInPackageTree()).isEmpty();
}

@Test
Expand Down
Expand Up @@ -221,7 +221,7 @@ public void iterates_all_classes() {

JavaPackage javaLang = defaultPackage.getPackage("java.lang");

assertThatTypes(javaLang.getAllClasses()).contain(Object.class, String.class, Annotation.class, Field.class);
assertThatTypes(javaLang.getClassesInPackageTree()).contain(Object.class, String.class, Annotation.class, Field.class);
}

@Test
Expand Down
Expand Up @@ -171,7 +171,7 @@ public void creates_JavaPackages() {

JavaPackage javaPackage = defaultPackage.getPackage("java.lang");
assertThatTypes(javaPackage.getClasses()).contain(Object.class, String.class, Integer.class);
assertThatTypes(javaPackage.getAllClasses()).contain(Object.class, Annotation.class, Field.class);
assertThatTypes(javaPackage.getClassesInPackageTree()).contain(Object.class, Annotation.class, Field.class);

assertThat(javaClasses.containPackage("java.util"))
.as("Classes contain package 'java.util'").isTrue();
Expand Down

0 comments on commit 7b31072

Please sign in to comment.