liquibase.servicelocator

Interface PackageScanClassResolver

All Known Implementing Classes:

DefaultPackageScanClassResolver, WebSpherePackageScanClassResolver

public interface PackageScanClassResolver

A resolver that can find resources based on package scanning.

Method Summary

Methods

Modifier and Type	Method and Description
void	addClassLoader(java.lang.ClassLoader classLoader) Adds the class loader to the existing loaders
void	addFilter(PackageScanFilter filter) Add a filter that will be applied to all scan operations
java.util.Set<java.lang.Class<?>>	findByFilter(PackageScanFilter filter, java.lang.String... packageNames) Attempts to discover classes filter by the provided filter
java.util.Set<java.lang.Class<?>>	findImplementations(java.lang.Class<?> parent, java.lang.String... packageNames) Attempts to discover classes that are assignable to the type provided.
java.util.Set<java.lang.ClassLoader>	getClassLoaders() Gets the ClassLoader instances that should be used when scanning for classes.
void	removeFilter(PackageScanFilter filter) Removes the filter
void	setClassLoaders(java.util.Set<java.lang.ClassLoader> classLoaders) Sets the ClassLoader instances that should be used when scanning for classes.

Method Detail

setClassLoaders

void setClassLoaders(java.util.Set<java.lang.ClassLoader> classLoaders)

Sets the ClassLoader instances that should be used when scanning for classes. If none is set then the context classloader will be used.

Parameters:

classLoaders - loaders to use when scanning for classes

getClassLoaders

java.util.Set<java.lang.ClassLoader> getClassLoaders()

Gets the ClassLoader instances that should be used when scanning for classes.

Returns:

the class loaders to use

addClassLoader

void addClassLoader(java.lang.ClassLoader classLoader)

Adds the class loader to the existing loaders

Parameters:

classLoader - the loader to add

findImplementations

java.util.Set<java.lang.Class<?>> findImplementations(java.lang.Class<?> parent,
                                                    java.lang.String... packageNames)

Attempts to discover classes that are assignable to the type provided. In the case that an interface is provided this method will collect implementations. In the case of a non-interface class, subclasses will be collected.

Parameters:

parent - the class of interface to find subclasses or implementations of

packageNames - one or more package names to scan (including subpackages) for classes

Returns:

the classes found, returns an empty set if none found

findByFilter

java.util.Set<java.lang.Class<?>> findByFilter(PackageScanFilter filter,
                                             java.lang.String... packageNames)

Attempts to discover classes filter by the provided filter

Parameters:

filter - filter to filter desired classes.

packageNames - one or more package names to scan (including subpackages) for classes

Returns:

the classes found, returns an empty set if none found

addFilter

void addFilter(PackageScanFilter filter)

Add a filter that will be applied to all scan operations

Parameters:

filter - filter to filter desired classes in all scan operations

removeFilter

void removeFilter(PackageScanFilter filter)

Removes the filter

Parameters:

filter - filter to filter desired classes in all scan operations