ClassPathScanner (Grails 4.1.0.M1)

grails.boot.config.tools.ClassPathScanner

Used to scan for classes on the classpath in the most efficient manner possible. WARNING: Classpath scanning can be expensive! Use with care.
Authors:
Graeme Rocher
Since:
3.1.12

Constructor Summary

Constructors
Constructor and description
`ClassPathScanner ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.util.List`	`ignoredRootPackages()` Returns: The root packages to ignore by default
	`protected boolean`	`isExcluded(Resource res)` Whether the given resource is excluded Parameters: `res` - The resource Returns: True if it should be excluded
	`Set`	`scan(java.lang.Class applicationClass)` Scans for classes relative to the given class Parameters: `applicationClass` - The class, usually the Application class Returns: A set of classes
	`Set`	`scan(java.lang.Class applicationClass, java.lang.Class annotationFilter)` Scans for classes relative to the given class Parameters: `applicationClass` - The class, usually the Application class `annotationFilter` - The annotation to filter by Returns: A set of classes
	`Set`	`scan(java.lang.Class applicationClass, Closure annotationFilter)` Scans for classes relative to the given class Parameters: `applicationClass` - The class, usually the Application class `annotationFilter` - The annotation to filter by Returns: A set of classes
	`Set`	`scan(java.lang.Class applicationClass, Collection packageNames, java.lang.Class annotationFilter)` Scans for classes relative to the given class Parameters: `applicationClass` - The class, usually the Application class `packageNames` - The package names to scan `annotationFilter` - The annotation to filter by Returns: A set of classes
	`Set`	`scan(java.lang.Class applicationClass, Collection packageNames, Closure annotationFilter)` Scans for classes relative to the given class Parameters: `applicationClass` - The class, usually the Application class `packageNames` - The package names to scan Returns: A set of classes
	`Set`	`scan(ResourcePatternResolver resourcePatternResolver, Collection packageNames, Closure annotationFilter)` Scans for classes in the given package names Parameters: `resourcePatternResolver` - The resolver to use `packageNames` - The package names Returns: The found classes
	`Set`	`scan(java.lang.ClassLoader classLoader, ResourcePatternResolver resourcePatternResolver, Collection packageNames, Closure annotationFilter)` Scans for classes in the given package names Parameters: `classLoader` - The classloader to use to load classes `resourcePatternResolver` - The resolver `packageNames` - The package names `annotationFilter` - The filter Returns: The classes

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - ClassPathScanner()
- Method Detail
  - protected java.util.List ignoredRootPackages()
    
    Returns:
    The root packages to ignore by default
  - protected boolean isExcluded(Resource res)
    
    Whether the given resource is excluded
    Parameters:
    res - The resource
    Returns:
    True if it should be excluded
  - Set scan(java.lang.Class applicationClass)
    
    Scans for classes relative to the given class
    Parameters:
    applicationClass - The class, usually the Application class
    Returns:
    A set of classes
  - Set scan(java.lang.Class applicationClass, java.lang.Class annotationFilter)
    
    Scans for classes relative to the given class
    Parameters:
    applicationClass - The class, usually the Application class
    annotationFilter - The annotation to filter by
    Returns:
    A set of classes
  - Set scan(java.lang.Class applicationClass, Closure annotationFilter)
    
    Scans for classes relative to the given class
    Parameters:
    applicationClass - The class, usually the Application class
    annotationFilter - The annotation to filter by
    Returns:
    A set of classes
  - Set scan(java.lang.Class applicationClass, Collection packageNames, java.lang.Class annotationFilter)
    
    Scans for classes relative to the given class
    Parameters:
    applicationClass - The class, usually the Application class
    packageNames - The package names to scan
    annotationFilter - The annotation to filter by
    Returns:
    A set of classes
  - Set scan(java.lang.Class applicationClass, Collection packageNames, Closure annotationFilter)
    
    Scans for classes relative to the given class
    Parameters:
    applicationClass - The class, usually the Application class
    packageNames - The package names to scan
    Returns:
    A set of classes
  - Set scan(ResourcePatternResolver resourcePatternResolver, Collection packageNames, Closure annotationFilter)
    
    Scans for classes in the given package names
    Parameters:
    resourcePatternResolver - The resolver to use
    packageNames - The package names
    Returns:
    The found classes
  - Set scan(java.lang.ClassLoader classLoader, ResourcePatternResolver resourcePatternResolver, Collection packageNames, Closure annotationFilter)
    
    Scans for classes in the given package names
    Parameters:
    classLoader - The classloader to use to load classes
    resourcePatternResolver - The resolver
    packageNames - The package names
    annotationFilter - The filter
    Returns:
    The classes

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class ClassPathScanner

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

ClassPathScanner()

Method Detail

protected java.util.List ignoredRootPackages()

protected boolean isExcluded(Resource res)

Set scan(java.lang.Class applicationClass)

Set scan(java.lang.Class applicationClass, java.lang.Class annotationFilter)

Set scan(java.lang.Class applicationClass, Closure annotationFilter)

Set scan(java.lang.Class applicationClass, Collection packageNames, java.lang.Class annotationFilter)

Set scan(java.lang.Class applicationClass, Collection packageNames, Closure annotationFilter)

Set scan(ResourcePatternResolver resourcePatternResolver, Collection packageNames, Closure annotationFilter)

Set scan(java.lang.ClassLoader classLoader, ResourcePatternResolver resourcePatternResolver, Collection packageNames, Closure annotationFilter)