top.wavelength.betterreflection.lookup

Class ClassFinder<T>

java.lang.Object

top.wavelength.betterreflection.lookup.ClassFinder<T>

Type Parameters:

T - the type of the classes to find

All Implemented Interfaces:

Iterable<BetterReflectionClass<T>>

Direct Known Subclasses:

IdeClassFinder, JarClassFinder

public abstract class ClassFinder<T>
extends Object
implements Iterable<BetterReflectionClass<T>>

An abstract class for finding classes in a package based on certain criteria.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
protected String	basePackage

Constructor Summary

Constructors

Constructor and Description
ClassFinder(String basePackage) Constructs a ClassFinder object with the given base package parameter.

Method Summary

Modifier and Type	Method and Description
ClassFinder<T>	classLoader(ClassLoader classLoader) Sets the class loader that will be used to load the classes for this ClassFinder instance.
abstract List<BetterReflectionClass<T>>	findClasses() Finds classes in a package based on certain criteria.
ClassLoader	getClassLoader() Retrieves the class loader currently set for this ClassFinder instance.
File	getJarFile() Retrieves the jar file currently set for this ClassFinder instance.
BetterReflectionClass<?>	getType() Retrieves the type of the ClassFinder instance.
boolean	isRecursive() Returns whether the ClassFinder instance is set to be recursive or not.
Iterator<BetterReflectionClass<T>>	iterator() Returns an iterator over the BetterReflectionClass objects representing the found classes.
ClassFinder<T>	jarFile(File jarFile) Sets the jar file that this ClassFinder will search for classes.
ClassFinder<T>	ofType(BetterReflectionClass<T> type) Sets the type of the ClassFinder instance.
ClassFinder<T>	ofType(Class<T> type) Sets the type of the ClassFinder instance.
ClassFinder<T>	recursive(boolean recursive) Sets the recursive flag of the ClassFinder instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

basePackage

protected final String basePackage

Since:

1.1

Constructor Detail

ClassFinder

public ClassFinder(String basePackage)

Constructs a ClassFinder object with the given base package parameter.

Parameters:

basePackage - the base package to search for classes in

Since:

1.1

Method Detail

ofType

public ClassFinder<T> ofType(Class<T> type)

Sets the type of the ClassFinder instance.

Parameters:

type - the type of the ClassFinder instance to set

Returns:

the updated ClassFinder instance

Since:

1.1

ofType

public ClassFinder<T> ofType(BetterReflectionClass<T> type)

Sets the type of the ClassFinder instance.

Parameters:

type - the type of the ClassFinder instance to set

Returns:

the updated ClassFinder instance

Since:

1.1

getType

public BetterReflectionClass<?> getType()

Retrieves the type of the ClassFinder instance.

Returns:

the BetterReflectionClass representing the type.

Since:

1.1

recursive

public ClassFinder<T> recursive(boolean recursive)

Sets the recursive flag of the ClassFinder instance.

Parameters:

recursive - the boolean value to set the recursive flag to

Returns:

the updated ClassFinder instance

Since:

1.1

isRecursive

public boolean isRecursive()

Returns whether the ClassFinder instance is set to be recursive or not.

Returns:

true if the ClassFinder instance is recursive, false otherwise.

Since:

1.1

classLoader

public ClassFinder<T> classLoader(ClassLoader classLoader)

Sets the class loader that will be used to load the classes for this ClassFinder instance.

Parameters:

classLoader - the ClassLoader instance to be used for loading classes

Returns:

the updated ClassFinder instance

Since:

1.3

getClassLoader

public ClassLoader getClassLoader()

Retrieves the class loader currently set for this ClassFinder instance.

Returns:

the ClassLoader instance being used to load classes

Since:

1.3

jarFile

public ClassFinder<T> jarFile(File jarFile)

Sets the jar file that this ClassFinder will search for classes.

Parameters:

jarFile - the File representing the jar file to search for classes

Returns:

the updated File instance

Since:

1.3

getJarFile

public File getJarFile()

Retrieves the jar file currently set for this ClassFinder instance.

Returns:

the File representing the jar file being searched for classes

Since:

1.3

findClasses

public abstract List<BetterReflectionClass<T>> findClasses()
                                                    throws IOException,
                                                           URISyntaxException

Finds classes in a package based on certain criteria.

Returns:

a list of BetterReflectionClass objects representing the found classes.

Throws:

IOException - if an I/O error occurs while finding the classes.

URISyntaxException - if a URI syntax error occurs while finding the classes.

Since:

1.1

iterator

public Iterator<BetterReflectionClass<T>> iterator()

Returns an iterator over the BetterReflectionClass objects representing the found classes.

Specified by:

iterator in interface Iterable<BetterReflectionClass<T>>

Returns:

an iterator over the BetterReflectionClass objects.

Throws:

RuntimeException - if an I/O error occurs while finding the classes.

Since:

1.1