org.springframework.boot.autoconfigure.domain

Class EntityScanner

java.lang.Object

org.springframework.boot.autoconfigure.domain.EntityScanner

public class EntityScanner
extends Object

An entity scanner that searches the classpath from an @EntityScan specified packages.

Since:

1.4.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor and Description
EntityScanner(ApplicationContext context) Create a new EntityScanner instance.

Method Summary

Modifier and Type	Method and Description
protected ClassPathScanningCandidateComponentProvider	createClassPathScanningCandidateComponentProvider(ApplicationContext context) Create a ClassPathScanningCandidateComponentProvider to scan entities based on the specified ApplicationContext.
Set<Class<?>>	scan(Class<? extends Annotation>... annotationTypes) Scan for entities with the specified annotations.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityScanner

public EntityScanner(ApplicationContext context)

Create a new EntityScanner instance.

Parameters:

context - the source application context

Method Detail

scan

@SafeVarargs
public final Set<Class<?>> scan(Class<? extends Annotation>... annotationTypes)
                                      throws ClassNotFoundException

Scan for entities with the specified annotations.

Parameters:

annotationTypes - the annotation types used on the entities

Returns:

a set of entity classes

Throws:

ClassNotFoundException - if an entity class cannot be loaded

createClassPathScanningCandidateComponentProvider

protected ClassPathScanningCandidateComponentProvider createClassPathScanningCandidateComponentProvider(ApplicationContext context)

Create a ClassPathScanningCandidateComponentProvider to scan entities based on the specified ApplicationContext.

Parameters:

context - the ApplicationContext to use

Returns:

a ClassPathScanningCandidateComponentProvider suitable to scan entities

Since:

2.4.0