io.permazen.spring

Class AnnotatedClassScanner

java.lang.Object

org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

io.permazen.spring.AnnotatedClassScanner

All Implemented Interfaces:

Aware, ResourceLoaderAware, EnvironmentCapable

Direct Known Subclasses:

PermazenClassScanner, PermazenFieldTypeScanner

public class AnnotatedClassScanner
extends ClassPathScanningCandidateComponentProvider

Scans the classpath for classes having one or more configured type annotations.

Field Summary

Fields inherited from class org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

logger

Constructor Summary

Constructors

Constructor and Description
AnnotatedClassScanner(boolean useDefaultFilters, Environment environment, Class<?>... annotationTypes) Constructor.
AnnotatedClassScanner(Class<?>... annotationTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	registerDefaultFilters() Register default include/exclude filters.
ArrayList<String>	scanForClasses(String... basePackages) Locate annotated classes on the classpath.

Methods inherited from class org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

addExcludeFilter, addIncludeFilter, clearCache, findCandidateComponents, getEnvironment, getMetadataReaderFactory, getRegistry, getResourceLoader, isCandidateComponent, isCandidateComponent, resetFilters, resolveBasePackage, setEnvironment, setMetadataReaderFactory, setResourceLoader, setResourcePattern

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedClassScanner

public AnnotatedClassScanner(Class<?>... annotationTypes)

Constructor. Enables use of default filters and uses a StandardEnvironment.

Parameters:

annotationTypes - type annotations to search for

Throws:

IllegalArgumentException - if annotationTypes is null, empty, or contains any non-annotation types

AnnotatedClassScanner

public AnnotatedClassScanner(boolean useDefaultFilters,
                             Environment environment,
                             Class<?>... annotationTypes)

Constructor.

Parameters:

useDefaultFilters - whether to register the default filters for the specified annotationTypes

environment - environment to use

annotationTypes - type annotations to search for

Throws:

IllegalArgumentException - if annotationTypes is null, empty, or contains any non-annotation types

Method Detail

scanForClasses

public ArrayList<String> scanForClasses(String... basePackages)

Locate annotated classes on the classpath. Does not actually load the classes.

Parameters:

basePackages - one or more base pacakge names

Returns:

list of names of classes having any of the configured type annotations

Throws:

IllegalArgumentException - if basePackages is empty

registerDefaultFilters

protected void registerDefaultFilters()

Register default include/exclude filters.

Overridden in AnnotatedClassScanner to set the default filters to be ones that match classes annotated with any of the annotation types provided to the constructor.

Overrides:

registerDefaultFilters in class ClassPathScanningCandidateComponentProvider