com.github.frontear.efkolia.utilities.inspect.Reflector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Efkolia Show documentation
A simple framework designed for Minecraft modding
There is a newer version: 0.2.8
package com.github.frontear.efkolia.utilities.inspect;

import com.github.frontear.efkolia.utilities.inspect.exceptions.NoSuchMappingException;
import com.github.frontear.internal.NotNull;
import java.lang.reflect.*;
import java.util.Arrays;
import lombok.*;
import lombok.experimental.UtilityClass;

/**
 * A simple reflection utility that allows for quick and easy reflection for various situations.
 */
@UtilityClass
public class Reflector {
    /**
     * Search for a field within a specific type and its super classes. If the field is found, an
     * instance of {@link Field} is returned with no additional modifications.
     *
     * @param type The type to search from initially, and to {@link Class#getSuperclass()} later.
     * @param name The name of the field.
     *
     * @return An instance of {@link Field} if an applicable field is found.
     *
     * @throws NoSuchFieldException If no field matching the name is found.
     */
    @NotNull
    @SneakyThrows(NoSuchMappingException.class)
    public Field getField(@NonNull Class type, @NonNull final String name)
        throws NoSuchFieldException {
        val copy = type; // kept for being able to log it via exception later

        do {
            val field = Arrays.stream(type.getDeclaredFields())
                .filter(x -> x.getName().equals(name)).findFirst();
            if (field.isPresent()) {
                return field.get();
            }
        }
        while ((type = type.getSuperclass()) != null);

        throw new NoSuchFieldException(String
            .format("No field found with name %s in %s (or any superclasses)", name,
                copy.getSimpleName()));
    }

    /**
     * Search for a method within a specific type and its super classes. If the method is found, an
     * instance of {@link Method} is returned with no additional modifications.
     *
     * @param type The type to search from initially, and to {@link Class#getSuperclass()} later.
     * @param name The name of the method.
     *
     * @return An instance of {@link Field} if an applicable method is found.
     *
     * @throws NoSuchMethodException If no method matching the name is found.
     */
    @NotNull
    @SneakyThrows(NoSuchMappingException.class)
    public Method getMethod(@NonNull Class type, @NonNull String name)
        throws NoSuchMethodException {
        val copy = type; // kept for being able to log it via exception later

        do {
            val method = Arrays.stream(type.getDeclaredMethods())
                .filter(x -> x.getName().equals(name)).findFirst();
            if (method.isPresent()) {
                return method.get();
            }
        }
        while ((type = type.getSuperclass()) != null);

        throw new NoSuchMethodException(String
            .format("No method found with name %s in %s (or any superclasses)", name,
                copy.getSimpleName()));
    }

    /**
     * Search for a class in the JVM. If the class is found, an instance of {@link Class} is
     * returned with no additional modifications.
     *
     * @param name The package and name of the class.
     *
     * @return An instance of {@link Class} if an applicable field is found.
     *
     * @throws ClassNotFoundException If no class matching the signature is found.
     */
    @NotNull
    @SneakyThrows(NoSuchMappingException.class)
    public Class getClass(@NonNull final String name) throws ClassNotFoundException {
        return Class.forName(name);
    }
}