net.minecraftforge.fart.api

Interface ClassProvider

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ClassLoaderClassProvider

public interface ClassProvider
extends java.io.Closeable

Provides basic information about classes including inheritance, fields, and methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClassProvider.Builder A ClassProvider.Builder is used to configure and construct a ClassProvider.
static interface	ClassProvider.IClassInfo Holds basic information about a class.
static interface	ClassProvider.IFieldInfo Holds basic information about a field contained in a class.
static interface	ClassProvider.IMethodInfo Holds basic information about a method contained in a class.

Method Summary

Modifier and Type	Method and Description
static ClassProvider.Builder	builder() Creates a default instance of a ClassProvider.Builder.
static ClassProvider	fromClassLoader(@Nullable java.lang.ClassLoader classLoader) Creates a class provider which reads class data from the provided classloader, or the classloader of this class if null.
static ClassProvider	fromJvmClasspath() Creates a class provider which reads class data from the default classloader that loaded this class.
static ClassProvider	fromPaths(java.nio.file.Path... paths) Creates a class provider which reads class data from the provided library paths.
java.util.Optional<? extends ClassProvider.IClassInfo>	getClass(java.lang.String cls) Queries the class information from this class path.

Methods inherited from interface java.io.Closeable

close

Method Detail

builder

static ClassProvider.Builder builder()

Creates a default instance of a ClassProvider.Builder.

The default supported library paths are ZIP files and directories. Upon calling ClassProvider.Builder.addLibrary(Path), the path will be walked for all class files and stored. Like a class path, entries added earlier take precedence over later entries with the same name.

fromPaths

static ClassProvider fromPaths(java.nio.file.Path... paths)

Creates a class provider which reads class data from the provided library paths. All queried class infos will be cached for subsequent queries.

The default supported library paths are ZIP files and directories. Each path will be walked for all class files and stored in order. Like a class path, entries added earlier take precedence over later entries with the same name.

Parameters:

paths - the paths to read from

See Also:

builder()

fromJvmClasspath

static ClassProvider fromJvmClasspath()

Creates a class provider which reads class data from the default classloader that loaded this class.

fromClassLoader

static ClassProvider fromClassLoader(@Nullable
                                     @Nullable java.lang.ClassLoader classLoader)

Creates a class provider which reads class data from the provided classloader, or the classloader of this class if null.

Parameters:

classLoader - the classloader to read from, or null for the default JVM classpath

getClass

java.util.Optional<? extends ClassProvider.IClassInfo> getClass(java.lang.String cls)

Queries the class information from this class path. An empty optional will be returned if the class cannot be found.

Parameters:

cls - the fully resolved classname, see Type.getInternalName()

Returns:

the optional class information