Package com.burchard36.api.utils.reflections

Class PackageScanner<T>

java.lang.Object

com.burchard36.api.utils.reflections.PackageScanner<T>

public class PackageScanner<T>
extends Object

A generic package scanner, that will scan a specific Package for a Class that extends another Class. Not really intended for users of this API to use, but feel free to.

Since:

2.1.8

Author:

Dalton Burchard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PackageScanner.InvocationErrorStatus	Returned as an Entry value when using invokeClass(java.lang.Class<? extends T>)
static class	PackageScanner.InvocationResult<T,InvocationErrorStatus>
static class	PackageScanner.PackageScannerException	The exception thrown when there is any generic error with this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Class<?>>	classesForPackage
protected Class<? extends T>	currentClassToSearch
protected Package	packageToSearch
protected List<Class<? extends T>>	result

Constructor Summary

Constructors

Constructor	Description
PackageScanner()	While not recommendedn creating another instance of this class, you still can You can get a running instance of this class after the API gets enabled, see BurchAPI.getPackageScanner()

Method Summary

Modifier and Type	Method	Description
List<Class<? extends T>>	execute()	Executes the query you set.
HashMap<Class<? extends Annotation>,Class<? extends T>>	findWithClassConstructorAnnotations(Class<? extends Annotation>... annotations)
protected List<Class<? extends T>>	getClassesExtendingThis(Package thePackage, Class<? extends T> that)
protected void	getClassesForPackage(String pkgName)
PackageScanner.InvocationResult<T,PackageScanner.InvocationErrorStatus>	invokeClass(Class<? extends T> clazz)
PackageScanner<T>	subclassSearchQuery(Package aPackage, Class<? extends T> aClass)	Sets the package to scan, and type to scan for.
PackageScanner<T>	updateTargetClass(Class<? extends T> clazz)	Use this when you are still using the same package previous set by using subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>) If you want to use a different Package, then use subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>)

Methods inherited from class java.lang.Object

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

Field Details

packageToSearch

protected Package packageToSearch

currentClassToSearch

protected Class<? extends T> currentClassToSearch

classesForPackage

protected List<Class<?>> classesForPackage

result

protected List<Class<? extends T>> result

Constructor Details

PackageScanner

public PackageScanner()

While not recommendedn creating another instance of this class, you still can
You can get a running instance of this class after the API gets enabled, see BurchAPI.getPackageScanner()

Method Details

updateTargetClass

public PackageScanner<T> updateTargetClass(Class<? extends T> clazz)

Use this when you are still using the same package previous set by using subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>)
If you want to use a different Package, then use subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>)

Parameters:

clazz - Target class you want to check, typically a YourClass.class argument.

Returns:

instance of this class

Since:

2.1.8

invokeClass

public final PackageScanner.InvocationResult<T,PackageScanner.InvocationErrorStatus> invokeClass(Class<? extends T> clazz)

findWithClassConstructorAnnotations

@SafeVarargs
public final HashMap<Class<? extends Annotation>,Class<? extends T>> findWithClassConstructorAnnotations(Class<? extends Annotation>... annotations)

subclassSearchQuery

public final PackageScanner<T> subclassSearchQuery(@Nonnull
 Package aPackage,
 @Nonnull
 Class<? extends T> aClass)

Sets the package to scan, and type to scan for.
This will also cache all the classes for the specific package.

Parameters:

aPackage - A Package the root package to start scanning at

aClass - The class you want the return value of this

Returns:

Instance of this class

Since:

2.1.8

execute

@Nonnull
public final List<Class<? extends T>> execute()

Executes the query you set. Make sure you call subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>) first or this will generate PackageScanner.PackageScannerException

Returns:

List of Class's that extend a class you specified in subclassSearchQuery(java.lang.Package, java.lang.Class<? extends T>)

Since:

2.1.8

getClassesExtendingThis

protected final List<Class<? extends T>> getClassesExtendingThis(Package thePackage,
 Class<? extends T> that)
                                                          throws IOException,
ClassNotFoundException,
URISyntaxException

Throws:

IOException

ClassNotFoundException

URISyntaxException

getClassesForPackage

protected final void getClassesForPackage(String pkgName)
                                   throws IOException,
URISyntaxException

Throws:

IOException

URISyntaxException