org.glassfish.hk2.utilities.reflection.internal.ClassReflectionHelperUtilities Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2015, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.hk2.utilities.reflection.internal;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.glassfish.hk2.utilities.reflection.MethodWrapper;
import org.glassfish.hk2.utilities.reflection.Pretty;
/**
* @author jwells
*
*/
public class ClassReflectionHelperUtilities {
final static String CONVENTION_POST_CONSTRUCT = "postConstruct";
final static String CONVENTION_PRE_DESTROY = "preDestroy";
private final static Set OBJECT_METHODS = getObjectMethods();
private final static Set OBJECT_FIELDS = getObjectFields();
private static Set getObjectMethods() {
return AccessController.doPrivileged(new PrivilegedAction>() {
@Override
public Set run() {
Set retVal = new LinkedHashSet();
for (Method method : Object.class.getDeclaredMethods()) {
retVal.add(new MethodWrapperImpl(method));
}
return retVal;
}
});
}
private static Set getObjectFields() {
return AccessController.doPrivileged(new PrivilegedAction>() {
@Override
public Set run() {
Set retVal = new LinkedHashSet();
for (Field field : Object.class.getDeclaredFields()) {
retVal.add(field);
}
return retVal;
}
});
}
private static Method[] secureGetDeclaredMethods(final Class clazz) {
return AccessController.doPrivileged(new PrivilegedAction() {
@Override
public Method[] run() {
return clazz.getDeclaredMethods();
}
});
}
private static Field[] secureGetDeclaredFields(final Class clazz) {
return AccessController.doPrivileged(new PrivilegedAction() {
@Override
public Field[] run() {
return clazz.getDeclaredFields();
}
});
}
/**
* Gets the EXACT set of MethodWrappers on this class only. No subclasses. So
* this set should be considered RAW and has not taken into account any subclasses
*
* @param clazz The class to examine
* @return
*/
private static Set getDeclaredMethodWrappers(final Class clazz) {
Method declaredMethods[] = secureGetDeclaredMethods(clazz);
Set retVal = new LinkedHashSet();
for (Method method : declaredMethods) {
retVal.add(new MethodWrapperImpl(method));
}
return retVal;
}
/**
* Gets the EXACT set of FieldWrappers on this class only. No subclasses. So
* this set should be considered RAW and has not taken into account any subclasses
*
* @param clazz The class to examine
* @return
*/
private static Set getDeclaredFieldWrappers(final Class clazz) {
Field declaredFields[] = secureGetDeclaredFields(clazz);
Set retVal = new LinkedHashSet();
for (Field field : declaredFields) {
retVal.add(field);
}
return retVal;
}
static Set getAllFieldWrappers(Class clazz) {
if (clazz == null) return Collections.emptySet();
if (Object.class.equals(clazz)) return OBJECT_FIELDS;
if (clazz.isInterface()) return Collections.emptySet();
Set retVal = new LinkedHashSet();
retVal.addAll(getDeclaredFieldWrappers(clazz));
retVal.addAll(getAllFieldWrappers(clazz.getSuperclass()));
return retVal;
}
/**
* Returns methods of a class, including those in superclasses and interfaces.
* @param clazz Class to get methods of
* @return
*/
static Set getAllMethodWrappers(Class clazz) {
if (clazz == null) return Collections.emptySet();
if (Object.class.equals(clazz)) return OBJECT_METHODS;
Set retVal = new LinkedHashSet();
if (clazz.isInterface()) {
for (Method m : clazz.getDeclaredMethods()) {
MethodWrapper wrapper = new MethodWrapperImpl(m);
retVal.add(wrapper);
}
for (Class extendee : clazz.getInterfaces()) {
retVal.addAll(getAllMethodWrappers(extendee));
}
}
else {
retVal.addAll(getDeclaredMethodWrappers(clazz));
retVal.addAll(getAllMethodWrappers(clazz.getSuperclass()));
}
return retVal;
}
static boolean isPostConstruct(Method m) {
if (m.isAnnotationPresent(PostConstruct.class)) {
if (m.getParameterTypes().length != 0) {
throw new IllegalArgumentException("The method " + Pretty.method(m) +
" annotated with @PostConstruct must not have any arguments");
}
return true;
}
if (m.getParameterTypes().length != 0) return false;
return CONVENTION_POST_CONSTRUCT.equals(m.getName());
}
static boolean isPreDestroy(Method m) {
if (m.isAnnotationPresent(PreDestroy.class)) {
if (m.getParameterTypes().length != 0) {
throw new IllegalArgumentException("The method " + Pretty.method(m) +
" annotated with @PreDestroy must not have any arguments");
}
return true;
}
if (m.getParameterTypes().length != 0) return false;
return CONVENTION_PRE_DESTROY.equals(m.getName());
}
}