Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LANG-1317: Add MethodUtils#findAnnotation and extend MethodUtils#getMethodsWithAnnotation for non-public, super-class and interface methods 

Add changes.xml entry and minimal clean-up.
This commit is contained in:
pascalschumacher 2017-04-21 10:45:03 +02:00
parent 46007c151e
commit 314b6b56be
2 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -85,6 +85,7 @@ The <action> type attribute can be add,update,fix,remove.
<action issue="LANG-1310" type="fix" dev="pschumacher" due-to="Don Jeba">MethodUtils.invokeMethod throws ArrayStoreException if using varargs arguments and smaller types than the method defines</action> <action issue="LANG-1310" type="fix" dev="pschumacher" due-to="Don Jeba">MethodUtils.invokeMethod throws ArrayStoreException if using varargs arguments and smaller types than the method defines</action>
<action issue="LANG-1313" type="add" dev="pschumacher" due-to="Tomschi">Add ArchUtils - An utility class for the "os.arch" system property</action> <action issue="LANG-1313" type="add" dev="pschumacher" due-to="Tomschi">Add ArchUtils - An utility class for the "os.arch" system property</action>
<action issue="LANG-1272" type="add" dev="ebourg">Add shuffle methods to ArrayUtils</action> <action issue="LANG-1272" type="add" dev="ebourg">Add shuffle methods to ArrayUtils</action>
<action issue="LANG-1317" type="add" dev="pschumacher" due-to="Yasser Zamani">Add MethodUtils#findAnnotation and extend MethodUtils#getMethodsWithAnnotation for non-public, super-class and interface methods</action>
</release> </release>
<release version="3.5" date="2016-10-13" description="New features including Java 9 detection"> <release version="3.5" date="2016-10-13" description="New features including Java 9 detection">

60
src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
View File

@ -866,9 +866,9 @@ public class MethodUtils {
* @param annotationCls * @param annotationCls
* the {@link java.lang.annotation.Annotation} that must be present on a method to be matched * the {@link java.lang.annotation.Annotation} that must be present on a method to be matched
* @param searchSupers * @param searchSupers
* determines if also a lookup in the entire inheritance hierarchy of the given class should be performed * determines if a lookup in the entire inheritance hierarchy of the given class should be performed
* @param ignoreAccess * @param ignoreAccess
* determines if also non public methods should be considered * determines if non public methods should be considered
* @return an array of Methods (possibly empty). * @return an array of Methods (possibly empty).
* @throws IllegalArgumentException * @throws IllegalArgumentException
* if the class or annotation are {@code null} * if the class or annotation are {@code null}
@ -888,9 +888,9 @@ public class MethodUtils {
* @param annotationCls * @param annotationCls
* the {@link Annotation} that must be present on a method to be matched * the {@link Annotation} that must be present on a method to be matched
* @param searchSupers * @param searchSupers
* determines if also a lookup in the entire inheritance hierarchy of the given class should be performed * determines if a lookup in the entire inheritance hierarchy of the given class should be performed
* @param ignoreAccess * @param ignoreAccess
* determines if also non public methods should be considered * determines if non public methods should be considered
* @return a list of Methods (possibly empty). * @return a list of Methods (possibly empty).
* @throws IllegalArgumentException * @throws IllegalArgumentException
* if the class or annotation are {@code null} * if the class or annotation are {@code null}
@ -904,7 +904,7 @@ public class MethodUtils {
Validate.isTrue(annotationCls != null, "The annotation class must not be null"); Validate.isTrue(annotationCls != null, "The annotation class must not be null");
List<Class<?>> classes = (searchSupers ? getAllSuperclassesAndInterfaces(cls) List<Class<?>> classes = (searchSupers ? getAllSuperclassesAndInterfaces(cls)
: new ArrayList<Class<?>>()); : new ArrayList<Class<?>>());
classes.add(0, cls); classes.add(cls);
final List<Method> annotatedMethods = new ArrayList<>(); final List<Method> annotatedMethods = new ArrayList<>();
for (Class<?> acls : classes) { for (Class<?> acls : classes) {
final Method[] methods = (ignoreAccess ? acls.getDeclaredMethods() : acls.getMethods()); final Method[] methods = (ignoreAccess ? acls.getDeclaredMethods() : acls.getMethods());
@ -918,12 +918,12 @@ public class MethodUtils {
} }
/** /**
* <p>Gets the annotation object that is present on the given method or any equivalent method in * <p>Gets the annotation object with the given annotation type that is present on the given method
* super classes and interfaces, with the given annotation type. Returns null if the annotation * or optionally on any equivalent method in super classes and interfaces. Returns null if the annotation
* type was not present on any of them.</p> * type was not present.</p>
* *
* <p>Stops searching for an annotation once the first annotation of the specified type has been * <p>Stops searching for an annotation once the first annotation of the specified type has been
* found. i.e, additional annotations of the specified type will be silently ignored.</p> * found. Additional annotations of the specified type will be silently ignored.</p>
* @param <A> * @param <A>
* the annotation type * the annotation type
* @param method * @param method
@ -931,7 +931,8 @@ public class MethodUtils {
* @param annotationCls * @param annotationCls
* the {@link Annotation} to check if is present on the method * the {@link Annotation} to check if is present on the method
* @param searchSupers * @param searchSupers
* determines if lookup in the entire inheritance hierarchy of the given class if was not directly present * determines if a lookup in the entire inheritance hierarchy of the given class is performed
* if the annotation was not directly present
* @param ignoreAccess * @param ignoreAccess
* determines if underlying method has to be accessible * determines if underlying method has to be accessible
* @return the first matching annotation, or {@code null} if not found * @return the first matching annotation, or {@code null} if not found
@ -944,13 +945,13 @@ public class MethodUtils {
Validate.isTrue(method != null, "The method must not be null"); Validate.isTrue(method != null, "The method must not be null");
Validate.isTrue(annotationCls != null, "The annotation class must not be null"); Validate.isTrue(annotationCls != null, "The annotation class must not be null");
if(!ignoreAccess && !MemberUtils.isAccessible(method)) { if (!ignoreAccess && !MemberUtils.isAccessible(method)) {
return null; return null;
} }
A annotation = method.getAnnotation(annotationCls); A annotation = method.getAnnotation(annotationCls);
if(annotation == null && searchSupers) { if (annotation == null && searchSupers) {
Class<?> mcls = method.getDeclaringClass(); Class<?> mcls = method.getDeclaringClass();
List<Class<?>> classes = getAllSuperclassesAndInterfaces(mcls); List<Class<?>> classes = getAllSuperclassesAndInterfaces(mcls);
for (Class<?> acls : classes) { for (Class<?> acls : classes) {
@ -959,7 +960,7 @@ public class MethodUtils {
equivalentMethod = (ignoreAccess ? acls.getDeclaredMethod(method.getName(), method.getParameterTypes()) equivalentMethod = (ignoreAccess ? acls.getDeclaredMethod(method.getName(), method.getParameterTypes())
: acls.getMethod(method.getName(), method.getParameterTypes())); : acls.getMethod(method.getName(), method.getParameterTypes()));
} catch (NoSuchMethodException e) { } catch (NoSuchMethodException e) {
// If not found, just keep on search // if not found, just keep searching
continue; continue;
} }
annotation = equivalentMethod.getAnnotation(annotationCls); annotation = equivalentMethod.getAnnotation(annotationCls);
@ -981,34 +982,33 @@ public class MethodUtils {
* @return the combined {@code List} of superclasses and interfaces in order * @return the combined {@code List} of superclasses and interfaces in order
* going up from this one * going up from this one
* {@code null} if null input * {@code null} if null input
* @since 3.6
*/ */
private static List<Class<?>> getAllSuperclassesAndInterfaces(final Class<?> cls) { private static List<Class<?>> getAllSuperclassesAndInterfaces(final Class<?> cls) {
if (cls == null) { if (cls == null) {
return null; return null;
} }
final List<Class<?>> classes = new ArrayList<>(); final List<Class<?>> allSuperClassesAndInterfaces = new ArrayList<>();
List<Class<?>> allSuperclasses = ClassUtils.getAllSuperclasses(cls); List<Class<?>> allSuperclasses = ClassUtils.getAllSuperclasses(cls);
int sci = 0; int superClassIndex = 0;
List<Class<?>> allInterfaces = ClassUtils.getAllInterfaces(cls); List<Class<?>> allInterfaces = ClassUtils.getAllInterfaces(cls);
int ifi = 0; int interfaceIndex = 0;
while (ifi < allInterfaces.size() || while (interfaceIndex < allInterfaces.size() ||
sci < allSuperclasses.size()) { superClassIndex < allSuperclasses.size()) {
Class<?> acls; Class<?> acls;
if (ifi >= allInterfaces.size()) { if (interfaceIndex >= allInterfaces.size()) {
acls = allSuperclasses.get(sci++); acls = allSuperclasses.get(superClassIndex++);
} else if (sci >= allSuperclasses.size()) { } else if (superClassIndex >= allSuperclasses.size()) {
acls = allInterfaces.get(ifi++); acls = allInterfaces.get(interfaceIndex++);
} else if (ifi < sci) { } else if (interfaceIndex < superClassIndex) {
acls = allInterfaces.get(ifi++); acls = allInterfaces.get(interfaceIndex++);
} else if (sci < ifi) { } else if (superClassIndex < interfaceIndex) {
acls = allSuperclasses.get(sci++); acls = allSuperclasses.get(superClassIndex++);
} else { } else {
acls = allInterfaces.get(ifi++); acls = allInterfaces.get(interfaceIndex++);
} }
classes.add(acls); allSuperClassesAndInterfaces.add(acls);
} }
return classes; return allSuperClassesAndInterfaces;
} }
} }