com.tngtech.archunit.junit.ReflectionUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of archunit-junit4 Show documentation
A Java architecture test library, to specify and assert architecture rules in plain Java - Module 'archunit-junit4'
There is a newer version: 1.3.0
/*
 * Copyright 2018 TNG Technology Consulting GmbH
 *
 * 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 com.tngtech.archunit.junit;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.tngtech.archunit.base.ArchUnitException.ReflectionException;
import com.tngtech.archunit.base.Function;

import static com.google.common.collect.Collections2.filter;

class ReflectionUtils {
    private ReflectionUtils() {
    }

    static Set> getAllSupertypes(Class type) {
        if (type == null) {
            return Collections.emptySet();
        }

        ImmutableSet.Builder> result = ImmutableSet.>builder()
                .add(type)
                .addAll(getAllSupertypes(type.getSuperclass()));
        for (Class c : type.getInterfaces()) {
            result.addAll(getAllSupertypes(c));
        }
        return result.build();
    }

    static Collection getAllFields(Class owner, Predicate predicate) {
        return filter(getAll(owner, new Collector() {
            @Override
            protected Collection extractFrom(Class type) {
                return ImmutableList.copyOf(type.getDeclaredFields());
            }
        }), toGuava(predicate));
    }

    static Collection getAllMethods(Class owner, Predicate predicate) {
        return filter(getAll(owner, new Collector() {
            @Override
            protected Collection extractFrom(Class type) {
                return ImmutableList.copyOf(type.getDeclaredMethods());
            }
        }), toGuava(predicate));
    }

    private static  List getAll(Class type, Collector collector) {
        for (Class t : getAllSupertypes(type)) {
            collector.collectFrom(t);
        }
        return collector.collected;
    }

    static  T newInstanceOf(Class type) {
        return com.tngtech.archunit.base.ReflectionUtils.newInstanceOf(type);
    }

    @SuppressWarnings("unchecked") // callers must know, what they do here, we can't make this compile safe anyway
    private static  T getValue(Field field, Object owner) {
        try {
            field.setAccessible(true);
            return (T) field.get(owner);
        } catch (IllegalAccessException e) {
            throw new ReflectionException(e);
        }
    }

    static  T getValueOrThrowException(Field field, Class fieldOwner, Function exceptionConverter) {
        try {
            if (Modifier.isStatic(field.getModifiers())) {
                return getValue(field, null);
            } else {
                return getValue(field, newInstanceOf(fieldOwner));
            }
        } catch (ReflectionException e) {
            throw exceptionConverter.apply(e.getCause());
        }
    }

    static  T invokeMethod(Method method, Class methodOwner, Object... args) {
        if (Modifier.isStatic(method.getModifiers())) {
            return invoke(null, method, args);
        } else {
            return invoke(newInstanceOf(methodOwner), method, args);
        }
    }

    @SuppressWarnings("unchecked") // callers must know, what they do here, we can't make this compile safe anyway
    private static  T invoke(Object owner, Method method, Object... args) {
        method.setAccessible(true);
        try {
            return (T) method.invoke(owner, args);
        } catch (IllegalAccessException e) {
            throw new ReflectionException(e);
        } catch (InvocationTargetException e) {
            ReflectionUtils.rethrowUnchecked(e.getTargetException());
            return null; // will never be reached
        }
    }

    // Certified Hack(TM) to rethrow any exception unchecked. Uses a hole in the JLS with respect to Generics.
    @SuppressWarnings("unchecked")
    private static  void rethrowUnchecked(Throwable throwable) throws T {
        throw (T) throwable;
    }

    private abstract static class Collector {
        private final List collected = new ArrayList<>();

        void collectFrom(Class type) {
            collected.addAll(extractFrom(type));
        }

        protected abstract Collection extractFrom(Class type);
    }

    static Predicate withAnnotation(final Class annotationType) {
        return new Predicate() {
            @Override
            public boolean apply(AnnotatedElement input) {
                return input.getAnnotation(annotationType) != null;
            }
        };
    }

    interface Predicate {
        boolean apply(T input);
    }

    private static  com.google.common.base.Predicate toGuava(final Predicate predicate) {
        return new com.google.common.base.Predicate() {
            @Override
            public boolean apply(T input) {
                return predicate.apply(input);
            }
        };
    }
}