Package org.springframework.data.util

Interface TypeScanner

public interface TypeScanner

A scanner that searches the classpath for matching types within given target packages.

Since:

3.0

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
default Set<Class<?>>	collectAsSet()	Obtain the scan result.
void	forEach(Consumer<Class<?>> action)	Performs the given action for each element found while scanning.
default TypeScanner	forTypesAnnotatedWith(Class<? extends Annotation>... annotations)	Define annotations identifying types to include in the scan result.
TypeScanner	forTypesAnnotatedWith(Collection<Class<? extends Annotation>> annotations)	Define annotations identifying types to include in the scan result.
TypeScanner	onClassNotFound(Consumer<ClassNotFoundException> action)	Define what happens in the case of a ClassNotFoundException.
default TypeScanner	scanPackages(String... packageNames)	Collects the names of packages to scan.
TypeScanner	scanPackages(Collection<String> packageNames)	Collects the names of packages to scan.
static TypeScanner	typeScanner(ClassLoader classLoader)	Create a new TypeScanner using the given ClassLoader.
static TypeScanner	typeScanner(ApplicationContext context)	Create a new TypeScanner using the given ApplicationContext.
static TypeScanner	typeScanner(ResourceLoader resourceLoader)	Create a new TypeScanner using the given ResourceLoader.

Method Details

typeScanner

static TypeScanner typeScanner(ClassLoader classLoader)

Create a new TypeScanner using the given ClassLoader.

Parameters:

classLoader - must not be null.

Returns:

new instance of TypeScanner.

typeScanner

static TypeScanner typeScanner(ResourceLoader resourceLoader)

Create a new TypeScanner using the given ResourceLoader.

Parameters:

resourceLoader - must not be null.

Returns:

new instance of TypeScanner.

typeScanner

static TypeScanner typeScanner(ApplicationContext context)

Create a new TypeScanner using the given ApplicationContext.

Parameters:

context - must not be null.

Returns:

new instance of TypeScanner.

scanPackages

default TypeScanner scanPackages(String... packageNames)

Collects the names of packages to scan.

Parameters:

packageNames - array of package names to scan; Must not be null.

Returns:

new instance of TypeScanner.

See Also:

• scanPackages(Collection)

scanPackages

TypeScanner scanPackages(Collection<String> packageNames)

Collects the names of packages to scan.

Parameters:

packageNames - Collection of package names to scan.

Returns:

new instance of TypeScanner.

See Also:

• scanPackages(String...)

forTypesAnnotatedWith

default TypeScanner forTypesAnnotatedWith(Class<? extends Annotation>... annotations)

Define annotations identifying types to include in the scan result.

Parameters:

annotations - must not be null.

Returns:

new instance of TypeScanner.

See Also:

• forTypesAnnotatedWith(Collection)

forTypesAnnotatedWith

TypeScanner forTypesAnnotatedWith(Collection<Class<? extends Annotation>> annotations)

Define annotations identifying types to include in the scan result.

Parameters:

annotations - must not be null.

Returns:

new instance of TypeScanner.

onClassNotFound

TypeScanner onClassNotFound(Consumer<ClassNotFoundException> action)

Define what happens in the case of a ClassNotFoundException.

Parameters:

action - must not be null.

Returns:

collectAsSet

default Set<Class<?>> collectAsSet()

Obtain the scan result.

Returns:

never null.

forEach

void forEach(Consumer<Class<?>> action)

Performs the given action for each element found while scanning.

Parameters:

action - must not be null.