org.jboss.as.server.deployment.reflect.ClassReflectionIndexUtil Maven / Gradle / Ivy
The newest version!
/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.server.deployment.reflect;
import java.lang.reflect.Method;
import java.util.Collection;
import org.jboss.as.server.ServerMessages;
import org.jboss.as.server.deployment.DeploymentUnitProcessingException;
import org.jboss.invocation.proxy.MethodIdentifier;
/**
* Utility methods for finding methods within a {@link ClassReflectionIndex} hierarchy.
*
* User: Jaikiran Pai
*/
public class ClassReflectionIndexUtil {
/**
* Finds and returns a method corresponding to the passed methodIdentifier.
* The passed classReflectionIndex will be used to traverse the class hierarchy while finding the method.
*
* Returns null if no such method is found
*
* @param deploymentReflectionIndex The deployment reflection index
* @param clazz The class reflection index which will be used to traverse the class hierarchy to find the method
* @param methodIdentifier The method identifier of the method being searched for
* @return
*/
public static Method findMethod(final DeploymentReflectionIndex deploymentReflectionIndex, final Class clazz, final MethodIdentifier methodIdentifier) {
Class c = clazz;
while (c != null) {
final ClassReflectionIndex index = deploymentReflectionIndex.getClassIndex(c);
final Method method = index.getMethod(methodIdentifier);
if(method != null) {
return method;
}
c = c.getSuperclass();
}
return null;
}
/**
* Finds and returns a method corresponding to the passed methodIdentifier.
* The passed classReflectionIndex will be used to traverse the class hierarchy while finding the method.
*
* Throws {@link org.jboss.as.server.deployment.DeploymentUnitProcessingException} if no such method is found.
*
* @param deploymentReflectionIndex The deployment reflection index
* @param clazz The class to search
* @param methodIdentifier The method identifier of the method being searched for
* @return
* @throws org.jboss.as.server.deployment.DeploymentUnitProcessingException
* If no such method is found
*/
public static Method findRequiredMethod(final DeploymentReflectionIndex deploymentReflectionIndex, final Class clazz, final MethodIdentifier methodIdentifier) throws DeploymentUnitProcessingException {
Method method = findMethod(deploymentReflectionIndex, clazz, methodIdentifier);
if (method == null) {
throw ServerMessages.MESSAGES.noMethodFound(methodIdentifier, clazz);
}
return method;
}
/**
* Finds and returns a method corresponding to the passed method, which may be declared in the super class
* of the passed classReflectionIndex.
*
*
* Throws {@link org.jboss.as.server.deployment.DeploymentUnitProcessingException} if no such method is found.
*
* @param deploymentReflectionIndex The deployment reflection index
* @param clazz The class
* @param method The method being searched for
* @return
* @throws org.jboss.as.server.deployment.DeploymentUnitProcessingException
* If no such method is found
*/
public static Method findRequiredMethod(final DeploymentReflectionIndex deploymentReflectionIndex, final Class clazz, final Method method) throws DeploymentUnitProcessingException {
if (method == null) {
throw ServerMessages.MESSAGES.nullMethod();
}
final MethodIdentifier methodIdentifier = MethodIdentifier.getIdentifierForMethod(method);
return findRequiredMethod(deploymentReflectionIndex, clazz, methodIdentifier);
}
/**
* Finds and returns a method corresponding to the passed method, which may be declared in the super class
* of the passed classReflectionIndex.
*
*
*
* @param deploymentReflectionIndex The deployment reflection index
* @param clazz The class
* @param method The method being searched for
* @return
*/
public static Method findMethod(final DeploymentReflectionIndex deploymentReflectionIndex, final Class clazz, final Method method) {
if (method == null) {
throw ServerMessages.MESSAGES.nullMethod();
}
MethodIdentifier methodIdentifier = MethodIdentifier.getIdentifierForMethod(method);
return findMethod(deploymentReflectionIndex, clazz, methodIdentifier);
}
/**
* Finds and returns methods corresponding to the passed method name and method paramTypes.
* The passed classReflectionIndex will be used to traverse the class hierarchy while finding the method.
*
* Returns empty collection if no such method is found
*
* @param deploymentReflectionIndex The deployment reflection index
* @param classReflectionIndex The class reflection index which will be used to traverse the class hierarchy to find the method
* @param methodName The name of the method
* @param paramTypes The param types accepted by the method
* @return
*/
public static Collection findMethods(final DeploymentReflectionIndex deploymentReflectionIndex, final ClassReflectionIndex classReflectionIndex, final String methodName, final String... paramTypes) {
final Collection methods = classReflectionIndex.getMethods(methodName, paramTypes);
if (!methods.isEmpty()) {
return methods;
}
// find on super class
Class superClass = classReflectionIndex.getIndexedClass().getSuperclass();
if (superClass != null) {
ClassReflectionIndex superClassIndex = deploymentReflectionIndex.getClassIndex(superClass);
if (superClassIndex != null) {
return findMethods(deploymentReflectionIndex, superClassIndex, methodName, paramTypes);
}
}
return methods;
}
/**
* Finds and returns all methods corresponding to the passed method name and method paramCount.
* The passed classReflectionIndex will be used to traverse the class hierarchy while finding the method.
*
* Returns empty collection if no such method is found
*
* @param deploymentReflectionIndex The deployment reflection index
* @param classReflectionIndex The class reflection index which will be used to traverse the class hierarchy to find the method
* @param methodName The name of the method
* @param paramCount The number of params accepted by the method
* @return
*/
public static Collection findAllMethods(final DeploymentReflectionIndex deploymentReflectionIndex, final ClassReflectionIndex classReflectionIndex, final String methodName, int paramCount) {
Collection methods = classReflectionIndex.getAllMethods(methodName, paramCount);
if (!methods.isEmpty()) {
return methods;
}
// find on super class
Class superClass = classReflectionIndex.getIndexedClass().getSuperclass();
if (superClass != null) {
ClassReflectionIndex superClassIndex = deploymentReflectionIndex.getClassIndex(superClass);
if (superClassIndex != null) {
return findAllMethods(deploymentReflectionIndex, superClassIndex, methodName, paramCount);
}
}
return methods;
}
/**
* Finds and returns all methods corresponding to the passed method name.
* The passed classReflectionIndex will be used to traverse the class hierarchy while finding the method.
*
* Returns empty collection if no such method is found
*
* @param deploymentReflectionIndex The deployment reflection index
* @param classReflectionIndex The class reflection index which will be used to traverse the class hierarchy to find the method
* @param methodName The name of the method
* @return
*/
public static Collection findAllMethodsByName(final DeploymentReflectionIndex deploymentReflectionIndex, final ClassReflectionIndex classReflectionIndex, final String methodName) {
Collection methods = classReflectionIndex.getAllMethods(methodName);
if (!methods.isEmpty()) {
return methods;
}
// find on super class
Class superClass = classReflectionIndex.getIndexedClass().getSuperclass();
if (superClass != null) {
ClassReflectionIndex superClassIndex = deploymentReflectionIndex.getClassIndex(superClass);
if (superClassIndex != null) {
return findAllMethodsByName(deploymentReflectionIndex, superClassIndex, methodName);
}
}
return methods;
}
}