Package me.deecaad.core.file

Class JarSearcher

java.lang.Object

me.deecaad.core.file.JarSearcher

Direct Known Subclasses:

JarInstancer, SerializerInstancer

public class JarSearcher
extends Object

This immutable class outlines a searcher that iterates through the files of a JarFile.

Constructor Summary

Constructors

Constructor	Description
JarSearcher(@NotNull JarFile jar)	This constructor will throw an IllegalArgumentException if the given jar is null.

Method Summary

Modifier and Type	Method	Description
<T> List<Class<T>>	findAllSubclasses(@NotNull Class<T> clazz, @NotNull ClassLoader clazzLoader, @NotNull SearchMode filter)	Returns a List of every class that inherits from the given class clazz that can be found in this searcher's JarFile.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JarSearcher

public JarSearcher(@NotNull
 @NotNull JarFile jar)

This constructor will throw an IllegalArgumentException if the given jar is null. JarFile instances can be obtained via FileUtil.getJarFile(Plugin, File).

Parameters:

jar - The .jar file to search.

Method Details

findAllSubclasses

public <T> List<Class<T>> findAllSubclasses(@NotNull
 @NotNull Class<T> clazz,
 @NotNull
 @NotNull ClassLoader clazzLoader,
 @NotNull
 @NotNull SearchMode filter)

Returns a List of every class that inherits from the given class clazz that can be found in this searcher's JarFile.

This is useful if addons to a plugin create an new implementation for a feature, so the main plugin doesn't have to write a registry system for each feature. Instead, the main plugin can pull all features from registered jars.

Type Parameters:

T - The parent class that all of these subclasses will have in common.

Parameters:

clazz - The class that the subclasses inherit from. This is generally an abstract class/interface.

clazzLoader - The class that is used to load classes

filter - The filter for which serializers to use

Returns:

A List of every subclass.