org.perfectable.introspection.Introspections Maven / Gradle / Ivy

Go to download
package org.perfectable.introspection;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Convenient entry point for introspections.
 *
 * Use {@link #introspect} to start introspection for either supported type.
 */
public final class Introspections {

	/**
	 * Introspect a class.
	 *
	 * @param type class to introspect
	 * @param  class parameter
	 * @return class introspections
	 */
	public static  ClassIntrospection introspect(Class type) {
		return ClassIntrospection.of(type);
	}

	/**
	 * Introspect a method.
	 *
	 * @param method method to introspect
	 * @return method introspections
	 */
	public static MethodIntrospection introspect(Method method) {
		return MethodIntrospection.of(method);
	}

	/**
	 * Introspect a field.
	 *
	 * @param field field to introspect
	 * @return field introspections
	 */
	public static FieldIntrospection introspect(Field field) {
		return FieldIntrospection.of(field);
	}

	/**
	 * Introspect a classloader.
	 *
	 * Java uses {@code null} classloader in most places to indicate bootstrap classloader. This is why this
	 * method actually accepts null as a parameter. In this case, a special introspection that deals with bootstrap
	 * classloader is returned.
	 *
	 * @param classLoader class loader to introspect, or null, if introspected classloader is bootstrap.
	 * @return classloader introspections
	 */
	public static ClassLoaderIntrospection introspect(@Nullable ClassLoader classLoader) {
		return ClassLoaderIntrospection.of(classLoader);
	}

	private Introspections() {
		// utility
	}
}