io.neba.core.util.ReflectionUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.neba.neba-core Show documentation
Show all versions of io.neba.neba-core Show documentation
Contains the entire NEBA core implementation, i.e. the framework that interprets the
NEBA API annotations and provides implementations for the service and lifecycle callback
interfaces provided in the NEBA API. This package must not export anything as
its implementation details are entirely private.
/*
Copyright 2013 the original author or authors.
Licensed under the Apache License, Version 2.0 the "License";
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package io.neba.core.util;
import org.apache.commons.lang3.reflect.TypeUtils;
import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.lang.reflect.TypeVariable;
import java.lang.reflect.WildcardType;
import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Queue;
import java.util.Set;
import static java.lang.reflect.Modifier.isPublic;
import static java.util.Arrays.asList;
import static java.util.Collections.addAll;
/**
* @author Olaf Otto
*/
public final class ReflectionUtil {
private static final int DEFAULT_COLLECTION_SIZE = 32;
/**
* Resolves the {@link Type} of the lower, or, if no lower bound is present, the upper bound of a single type argument of a
* {@link ParameterizedType}.
*
*
* private List<MyModel> myModel -> MyModel.
* private List<? extends MyModel> myModel -> MyModel.
* private List<? super MyModel> myModel -> MyModel.
* private List<T> myModel | T extends MyModel -> MyModel.
* private Optional<MyModel> myModel -> MyModel.
*
*
* @param type must not be null.
* @return never null.
*/
public static Type getBoundaryOfParametrizedType(final Type type, final Type assigningType) {
if (type == null) {
throw new IllegalArgumentException("Method parameter type must not be null.");
}
// The generic type may contain the generic type declarations, e.g. List.
if (!(type instanceof ParameterizedType)) {
throw new IllegalArgumentException("Cannot obtain the component type of " + type +
", it does not declare generic type parameters.");
}
// Only the ParametrizedType contains reflection information about the actual type.
ParameterizedType parameterizedType = (ParameterizedType) type;
Type[] typeArguments = parameterizedType.getActualTypeArguments();
// We expect exactly one argument representing the model type.
if (typeArguments.length != 1) {
signalUnsupportedNumberOfTypeDeclarations(type);
}
Type resolvedType = typeArguments[0];
// Wildcard type
if (resolvedType instanceof WildcardType) {
resolvedType = resolveWildCard((WildcardType) resolvedType, assigningType);
}
if (resolvedType instanceof TypeVariable) {
resolvedType = resolveTypeVariable((TypeVariable) resolvedType, assigningType);
}
if (resolvedType == null) {
throw new IllegalArgumentException("Cannot obtain the generic type of " + type +
", it has a generic signature with no resolvable lower or upper boundary. " +
"Either a specific type, e.g. List, a lower bound, e.g. List " +
"or an upper bound, e.g. List must be resolvable for the generic signature.");
}
return resolvedType;
}
private static Type resolveTypeVariable(final TypeVariable variable, final Type assigningType) {
// Can the type variable be resolved?
if (TypeUtils.getRawType(variable, assigningType) == null) {
// It cannot be resolved - we must look at the boundaries.
Type[] bounds = variable.getBounds();
// Type variables only have upper bounds. There are now four options:
// 1: There are multiple boundaries, e.g. , which means the type cannot be derived. Bail.
if (bounds.length != 1) {
return null;
}
// 2: There is one boundary, and it is java.lan.Object. This means there is none. Bail.
if (bounds[0] == Object.class) {
return null;
}
// 3: There is one boundary, and it's a Type Variable. Repeat.
if (bounds[0] instanceof TypeVariable) {
return resolveTypeVariable((TypeVariable) bounds[0], assigningType);
}
// 4: There is one boundary, and it's a Parametrized or wildcard type. Return the respective type, e.g. List> -> SomeType
if (bounds[0] instanceof WildcardType) {
return resolveWildCard((WildcardType) bounds[0], assigningType);
}
return bounds[0];
}
return variable;
}
private static Type resolveWildCard(final WildcardType typeArgument, Type assigningType) {
Type resolvedType = null;
// Start with the lower boundary as it is the most specific
Type[] boundaries = typeArgument.getLowerBounds();
if (boundaries.length != 0) {
resolvedType = boundaries[0];
} else {
// Fall back to the upper bounds
boundaries = typeArgument.getUpperBounds();
if (boundaries.length != 0) {
resolvedType = boundaries[0];
}
}
if (resolvedType == null || resolvedType == Object.class) {
return null;
}
if (resolvedType instanceof WildcardType) {
resolvedType = resolveWildCard((WildcardType) resolvedType, assigningType);
}
if (resolvedType instanceof TypeVariable) {
resolvedType = resolveTypeVariable((TypeVariable) resolvedType, assigningType);
}
return resolvedType;
}
private static void signalUnsupportedNumberOfTypeDeclarations(Type type) {
throw new IllegalArgumentException("Cannot obtain the component type of " + type +
", it must have exactly one parameter type, e.g. .");
}
/**
* Provides an implementation instance for the desired collection type.
* Example: If the collection type is {@link List}, a suitable list implementation is instantiated.
*
* @param collectionType must not be null.
* @return never null. Throws an {@link IllegalStateException}
* if the collection type is not supported.
*/
@SuppressWarnings("unchecked")
public static > Collection instantiateCollectionType(Class collectionType, int length) {
if (collectionType == null) {
throw new IllegalArgumentException("Method parameter collectionType must not be null.");
}
T collection;
// This includes java.util.Collection
if (collectionType.isAssignableFrom(List.class)) {
collection = (T) new ArrayList(length);
} else if (collectionType.isAssignableFrom(Set.class)) {
collection = (T) new LinkedHashSet(length);
} else {
throw new IllegalArgumentException("Unable to instantiate a collection of type " + collectionType +
". Only collections assignable from " + List.class + " or " + Set.class + " are supported.");
}
return collection;
}
/**
* @param type must not be null.
* @return whether the given collection type can be instantiated using {@link #instantiateCollectionType(Class)}.
*/
public static boolean isInstantiableCollectionType(Class type) {
if (type == null) {
throw new IllegalArgumentException("Method argument type must not be null.");
}
for (Class supportedType : getInstantiableCollectionTypes()) {
if (type.isAssignableFrom(supportedType)) {
return true;
}
}
return false;
}
/**
* @return an array of the types a collection type
* must be {@link Class#isAssignableFrom(Class) assignable from} in order to be
* {@link #isInstantiableCollectionType(Class) instantiable}.
*/
public static Class[] getInstantiableCollectionTypes() {
return new Class[]{List.class, Set.class};
}
/**
* Creates an instance with a default capacity.
*
* @see #instantiateCollectionType(Class, int)
*/
public static > Collection instantiateCollectionType(Class collectionType) {
return instantiateCollectionType(collectionType, DEFAULT_COLLECTION_SIZE);
}
/**
* All methods of the given type, its super types and interfaces, starting with the methods of
* the given type.
*
* @param type must not be null.
* @return never null but rather an empty list.
*/
public static List methodsOf(Class type) {
if (type == null) {
throw new IllegalArgumentException("Method argument type must not be null");
}
List methods = new LinkedList<>();
Queue> classes = new LinkedList<>();
classes.add(type);
while (!classes.isEmpty()) {
Class c = classes.poll();
methods.addAll(asList(c.getDeclaredMethods()));
if (c.getSuperclass() != null) {
classes.add(c.getSuperclass());
}
addAll(classes, c.getInterfaces());
}
return methods;
}
/**
* @param type must not be null.
* @param name must not be null.
* @return the {@link Class#getDeclaredFields() declared field} with the given name, or null
*/
public static Field findField(Class type, String name) {
if (type == null) {
throw new IllegalArgumentException("Method argument type must not be null");
}
if (name == null) {
throw new IllegalArgumentException("Method argument name must not be null");
}
Class c = type;
do {
for (Field f : c.getDeclaredFields()) {
if (name.equals(f.getName())) {
return f;
}
}
c = c.getSuperclass();
} while (c != null);
return null;
}
/**
* Makes the {@link Field#setAccessible(boolean) accessible} only if it is not.
*
* @param field must not be null.
* @return the given field.
*/
public static Field makeAccessible(Field field) {
if (field == null) {
throw new IllegalArgumentException("Method argument field must not be null.");
}
if (isInaccessible(field) && !field.isAccessible()) {
field.setAccessible(true);
}
return field;
}
/**
* Makes the {@link Method#setAccessible(boolean) accessible} only if it is not.
*
* @param method must not be null.
* @return the given method.
*/
public static Method makeAccessible(Method method) {
if (method == null) {
throw new IllegalArgumentException("Method argument method must not be null.");
}
if (isInaccessible(method) && !method.isAccessible()) {
method.setAccessible(true);
}
return method;
}
private static boolean isInaccessible(Member member) {
return !isPublic(member.getModifiers()) ||
!isPublic(member.getDeclaringClass().getModifiers());
}
private ReflectionUtil() {
}
}