Skip to content

Commit

Permalink
Harmonize application of method and field filters in search algorithms
Browse files Browse the repository at this point in the history
This commit consistently applies method predicates in search algorithms
analogous to the application of field predicates.

See #3498
See #3532
Closes #3534
  • Loading branch information
sbrannen committed Nov 4, 2023
1 parent f30a8d5 commit a670d10
Showing 1 changed file with 24 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1407,11 +1407,11 @@ private static Optional<Method> findMethod(Class<?> clazz, Predicate<Method> pre

for (Class<?> current = clazz; isSearchable(current); current = current.getSuperclass()) {
// Search for match in current type
List<Method> methods = current.isInterface() ? getMethods(current) : getDeclaredMethods(current, BOTTOM_UP);
for (Method method : methods) {
if (predicate.test(method)) {
return Optional.of(method);
}
List<Method> methods = current.isInterface() ? getMethods(current, predicate)
: getDeclaredMethods(current, predicate, BOTTOM_UP);
if (!methods.isEmpty()) {
// Since the predicate has already been applied, return the first match.
return Optional.of(methods.get(0));
}

// Search for match in interfaces implemented by current type
Expand Down Expand Up @@ -1506,8 +1506,8 @@ private static List<Method> findAllMethodsInHierarchy(Class<?> clazz, Predicate<
Preconditions.notNull(traversalMode, "HierarchyTraversalMode must not be null");

// @formatter:off
List<Method> localMethods = getDeclaredMethods(clazz, traversalMode).stream()
.filter(predicate.and(method -> !method.isSynthetic()))
List<Method> localMethods = getDeclaredMethods(clazz, predicate, traversalMode).stream()
.filter(method -> !method.isSynthetic())
.collect(toList());
List<Method> superclassMethods = getSuperclassMethods(clazz, predicate, traversalMode).stream()
.filter(method -> !isMethodShadowedByLocalMethods(method, localMethods))
Expand All @@ -1533,7 +1533,6 @@ private static List<Method> findAllMethodsInHierarchy(Class<?> clazz, Predicate<
/**
* Custom alternative to {@link Class#getFields()} that sorts the fields
* which match the supplied predicate and converts them to a mutable list.
* @param predicate the field filter; never {@code null}
*/
private static List<Field> getFields(Class<?> clazz, Predicate<Field> predicate) {
return toSortedMutableList(clazz.getFields(), predicate);
Expand All @@ -1542,32 +1541,33 @@ private static List<Field> getFields(Class<?> clazz, Predicate<Field> predicate)
/**
* Custom alternative to {@link Class#getDeclaredFields()} that sorts the
* fields which match the supplied predicate and converts them to a mutable list.
* @param predicate the field filter; never {@code null}
*/
private static List<Field> getDeclaredFields(Class<?> clazz, Predicate<Field> predicate) {
return toSortedMutableList(clazz.getDeclaredFields(), predicate);
}

/**
* Custom alternative to {@link Class#getMethods()} that sorts the methods
* and converts them to a mutable list.
* which match the supplied predicate and converts them to a mutable list.
*/
private static List<Method> getMethods(Class<?> clazz) {
return toSortedMutableList(clazz.getMethods());
private static List<Method> getMethods(Class<?> clazz, Predicate<Method> predicate) {
return toSortedMutableList(clazz.getMethods(), predicate);
}

/**
* Custom alternative to {@link Class#getDeclaredMethods()} that sorts the
* methods and converts them to a mutable list.
* methods which match the supplied predicate and converts them to a mutable list.
*
* <p>In addition, the list returned by this method includes interface
* default methods which are either prepended or appended to the list of
* declared methods depending on the supplied traversal mode.
*/
private static List<Method> getDeclaredMethods(Class<?> clazz, HierarchyTraversalMode traversalMode) {
private static List<Method> getDeclaredMethods(Class<?> clazz, Predicate<Method> predicate,
HierarchyTraversalMode traversalMode) {

// Note: getDefaultMethods() already sorts the methods,
List<Method> defaultMethods = getDefaultMethods(clazz);
List<Method> declaredMethods = toSortedMutableList(clazz.getDeclaredMethods());
List<Method> defaultMethods = getDefaultMethods(clazz, predicate);
List<Method> declaredMethods = toSortedMutableList(clazz.getDeclaredMethods(), predicate);

// Take the traversal mode into account in order to retain the inherited
// nature of interface default methods.
Expand All @@ -1584,23 +1584,23 @@ private static List<Method> getDeclaredMethods(Class<?> clazz, HierarchyTraversa
/**
* Get a sorted, mutable list of all default methods present in interfaces
* implemented by the supplied class which are also <em>visible</em> within
* the supplied class.
* the supplied class and match the supplied predicate.
*
* @see <a href="https://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#d5e9652">Method Visibility</a>
* in the Java Language Specification
*/
private static List<Method> getDefaultMethods(Class<?> clazz) {
private static List<Method> getDefaultMethods(Class<?> clazz, Predicate<Method> predicate) {
// @formatter:off
// Visible default methods are interface default methods that have not
// been overridden.
List<Method> visibleDefaultMethods = Arrays.stream(clazz.getMethods())
.filter(Method::isDefault)
.filter(predicate.and(Method::isDefault))
.collect(toCollection(ArrayList::new));
if (visibleDefaultMethods.isEmpty()) {
return visibleDefaultMethods;
}
return Arrays.stream(clazz.getInterfaces())
.map(ReflectionUtils::getMethods)
.map(ifc -> getMethods(ifc, predicate))
.flatMap(List::stream)
.filter(visibleDefaultMethods::contains)
.collect(toCollection(ArrayList::new));
Expand All @@ -1617,9 +1617,10 @@ private static List<Field> toSortedMutableList(Field[] fields, Predicate<Field>
// @formatter:on
}

private static List<Method> toSortedMutableList(Method[] methods) {
private static List<Method> toSortedMutableList(Method[] methods, Predicate<Method> predicate) {
// @formatter:off
return Arrays.stream(methods)
.filter(predicate)
.sorted(ReflectionUtils::defaultMethodSorter)
// Use toCollection() instead of toList() to ensure list is mutable.
.collect(toCollection(ArrayList::new));
Expand Down Expand Up @@ -1658,8 +1659,8 @@ private static List<Method> getInterfaceMethods(Class<?> clazz, Predicate<Method
for (Class<?> ifc : clazz.getInterfaces()) {

// @formatter:off
List<Method> localInterfaceMethods = getMethods(ifc).stream()
.filter(predicate.and(method -> !isAbstract(method)))
List<Method> localInterfaceMethods = getMethods(ifc, predicate).stream()
.filter(method -> !isAbstract(method))
.collect(toList());

List<Method> superinterfaceMethods = getInterfaceMethods(ifc, predicate, traversalMode).stream()
Expand Down

0 comments on commit a670d10

Please sign in to comment.