Package org.springframework.data.gemfire.config.annotation.support

Class GemFireComponentClassTypeScanner

java.lang.Object

org.springframework.data.gemfire.config.annotation.support.GemFireComponentClassTypeScanner

All Implemented Interfaces:

Iterable<String>

public class GemFireComponentClassTypeScanner
extends Object
implements Iterable<String>

The GemFireComponentClassTypeScanner class is a classpath component scanner used to search for GemFire components based on Class type.

Since:

1.9.0

Author:

John Blum

See Also:

• Iterable
• ConfigurableApplicationContext
• ClassPathScanningCandidateComponentProvider
• Environment
• TypeFilter

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GemFireComponentClassTypeScanner(Set<String> basePackages)	Constructs an instance of the GemFireComponentClassTypeScanner initialized with the given Set of base packages to scan.

Method Summary

Modifier and Type	Method	Description
static GemFireComponentClassTypeScanner	from(Iterable<String> basePackages)	Factory method to construct an instance of the GemFireComponentClassTypeScanner initialized with the given Iterable of base packages to scan.
static GemFireComponentClassTypeScanner	from(String... basePackages)	Factory method to construct an instance of the GemFireComponentClassTypeScanner initialized with the given array of base packages to scan.
protected ConfigurableApplicationContext	getApplicationContext()	Returns a reference to the Spring ApplicationContext.
protected Set<String>	getBasePackages()	Returns an unmodifiable Set of base packages to scan for GemFire components.
protected ClassLoader	getEntityClassLoader()	Returns a reference to the ClassLoader used to find and load GemFire application persistent entity classes.
protected Environment	getEnvironment()	Returns a reference to the Spring Environment in which the Spring GemFire application is running.
protected Iterable<TypeFilter>	getExcludes()	Returns a collection of TypeFilters used to exclude types found during the classpath component scan.
protected Iterable<TypeFilter>	getIncludes()	Returns a collection of TypeFilters used to include (match) types found during the classpath component scan.
Iterator<String>	iterator()
protected ClassPathScanningCandidateComponentProvider	newClassPathScanningCandidateComponentProvider()	Constructs a new instance of the ClassPathScanningCandidateComponentProvider initialized with no default filters.
protected ClassPathScanningCandidateComponentProvider	newClassPathScanningCandidateComponentProvider(boolean useDefaultFilters)	Constructs a new instance of the ClassPathScanningCandidateComponentProvider initialized with the useDefaultFilters boolean value to indicate whether to use default values or not.
Set<Class<?>>	scan()	Scans the Set of base packages searching for GemFire application components accepted by the filters of this scanner.
GemFireComponentClassTypeScanner	with(ClassLoader entityClassLoader)
GemFireComponentClassTypeScanner	with(ConfigurableApplicationContext applicationContext)
GemFireComponentClassTypeScanner	withExcludes(Iterable<TypeFilter> excludes)
GemFireComponentClassTypeScanner	withExcludes(TypeFilter... excludes)
GemFireComponentClassTypeScanner	withIncludes(Iterable<TypeFilter> includes)
GemFireComponentClassTypeScanner	withIncludes(TypeFilter... includes)

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 Details

logger

protected final org.slf4j.Logger logger

Constructor Details

GemFireComponentClassTypeScanner

protected GemFireComponentClassTypeScanner(Set<String> basePackages)

Constructs an instance of the GemFireComponentClassTypeScanner initialized with the given Set of base packages to scan.

Parameters:

basePackages - Set of base packages to scan for GemFire component clases.

Throws:

IllegalArgumentException - if the Set is null or empty.

See Also:

• Set

Method Details

from

public static GemFireComponentClassTypeScanner from(String... basePackages)

Factory method to construct an instance of the GemFireComponentClassTypeScanner initialized with the given array of base packages to scan.

Parameters:

basePackages - array of base packages to scan for GemFire components.

Returns:

an initialized instance of GemFireComponentClassTypeScanner.

Throws:

IllegalArgumentException - if the array of base packages is null or empty.

See Also:

• GemFireComponentClassTypeScanner(Set)

from

public static GemFireComponentClassTypeScanner from(Iterable<String> basePackages)

Factory method to construct an instance of the GemFireComponentClassTypeScanner initialized with the given Iterable of base packages to scan.

Parameters:

basePackages - Iterable of base packages to scan for GemFire components.

Returns:

an initialized instance of GemFireComponentClassTypeScanner.

Throws:

IllegalArgumentException - if the Iterable of base packages is null or empty.

See Also:

• GemFireComponentClassTypeScanner(Set)

getApplicationContext

protected ConfigurableApplicationContext getApplicationContext()

Returns a reference to the Spring ApplicationContext.

Returns:

a reference to the Spring ApplicationContext.

See Also:

• ConfigurableApplicationContext

getBasePackages

protected Set<String> getBasePackages()

Returns an unmodifiable Set of base packages to scan for GemFire components.

Returns:

an unmodifiable Set of base packages to scan for GemFire components.

See Also:

• Set

getEntityClassLoader

protected ClassLoader getEntityClassLoader()

Returns a reference to the ClassLoader used to find and load GemFire application persistent entity classes.

Returns:

the ClassLoader used to find and load GemFire application persistent entity classes.

See Also:

• ConfigurableBeanFactory.getBeanClassLoader()
• Thread.getContextClassLoader()
• ClassLoader
• getApplicationContext()

getEnvironment

protected Environment getEnvironment()

Returns a reference to the Spring Environment in which the Spring GemFire application is running.

Returns:

a reference to the Spring Environment.

See Also:

• EnvironmentCapable.getEnvironment()
• Environment
• StandardEnvironment
• getApplicationContext()

getExcludes

protected Iterable<TypeFilter> getExcludes()

Returns a collection of TypeFilters used to exclude types found during the classpath component scan.

Returns:

a collection of TypeFilter objects

See Also:

• TypeFilter
• Iterable

getIncludes

protected Iterable<TypeFilter> getIncludes()

Returns a collection of TypeFilters used to include (match) types found during the classpath component scan.

Returns:

a collection of TypeFilter objects

See Also:

• TypeFilter
• Iterable

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

scan

public Set<Class<?>> scan()

Scans the Set of base packages searching for GemFire application components accepted by the filters of this scanner.

Returns:

a Set of GemFire application component Class types found on the classpath.

See Also:

• newClassPathScanningCandidateComponentProvider(boolean)
• Set

newClassPathScanningCandidateComponentProvider

protected ClassPathScanningCandidateComponentProvider newClassPathScanningCandidateComponentProvider()

Constructs a new instance of the ClassPathScanningCandidateComponentProvider initialized with no default filters.

Returns:

a new instance of the ClassPathScanningCandidateComponentProvider.

See Also:

• ClassPathScanningCandidateComponentProvider
• newClassPathScanningCandidateComponentProvider(boolean)

newClassPathScanningCandidateComponentProvider

protected ClassPathScanningCandidateComponentProvider newClassPathScanningCandidateComponentProvider(boolean useDefaultFilters)

Constructs a new instance of the ClassPathScanningCandidateComponentProvider initialized with the useDefaultFilters boolean value to indicate whether to use default values or not. Additionally, the exclude/include filters are also set.

Parameters:

useDefaultFilters - boolean value to indicate whether to use default filters.

Returns:

a new instance of the ClassPathScanningCandidateComponentProvider.

See Also:

• ClassPathScanningCandidateComponentProvider
• newClassPathScanningCandidateComponentProvider(boolean)

with

public GemFireComponentClassTypeScanner with(ClassLoader entityClassLoader)

with

public GemFireComponentClassTypeScanner with(ConfigurableApplicationContext applicationContext)

withExcludes

public GemFireComponentClassTypeScanner withExcludes(TypeFilter... excludes)

withExcludes

public GemFireComponentClassTypeScanner withExcludes(Iterable<TypeFilter> excludes)

withIncludes

public GemFireComponentClassTypeScanner withIncludes(TypeFilter... includes)

withIncludes

public GemFireComponentClassTypeScanner withIncludes(Iterable<TypeFilter> includes)