ClassPathScanner (eframe 0.5 API)

org.simplemes.eframe.misc.ClassPathScanner

```
@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class ClassPathScanner
extends java.lang.Object
```
Utility to scan the class path for folder with resources from all modules (.jar files) and class path directories. Supports only the format: 'folder/*.ext'.

Properties Summary

Properties
Type	Name and description
`private java.lang.ClassLoader`	`classLoader` The classloader to use
`private static org.simplemes.eframe.misc.ClassPathScannerFactory`	`factory` The factory to build a class path scanner.
`private java.util.regex.Pattern`	`searchPattern` The Matching pattern for the given search spec.
`private java.lang.String`	`searchSpec` The path format to search for.

Constructor Summary

Constructors
Constructor and description
`ClassPathScanner (java.lang.String searchSpec)` Builds a scanner for the given search spec.
`ClassPathScanner ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.net.URL`	`buildJarFileUrl(java.io.File file, java.lang.String path)` Builds a jar file URL for the given jar file and path.
	`java.lang.String`	`getJarFilePath(java.net.URL url)` Gets the file name for the given JAR file URL.
	`java.lang.String`	`getRootPath()` Returns the root path for the desired resources.
	`java.lang.String`	`match(java.net.URL url)` Returns the portion of the given URL matches the desired search spec.
	`java.lang.String`	`match(java.lang.String url)` Returns the portion of the given URL matches the desired search spec.
	`java.util.List`	`scan()` Scans the classpath for matching resources.
	`java.util.List`	`scanFileFolder(java.io.File folder)` Scan a file folder, including sub-folders.
	`java.util.List`	`scanJarFolder(java.io.File file)` Scan a JAR file folder, including sub-folders.
	`java.util.List`	`scanResource(java.net.URL url)` Scans a single resource for sub-elements that match the pattern.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), 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()`

- Property Detail
  - private java.lang.ClassLoader classLoader
    
    The classloader to use
  - private static org.simplemes.eframe.misc.ClassPathScannerFactory factory
    
    The factory to build a class path scanner. This allows tests to provide specific results from the scan() method.
  - private java.util.regex.Pattern searchPattern
    
    The Matching pattern for the given search spec.
  - private java.lang.String searchSpec
    
    The path format to search for. Supports only the format: 'folder/*.ext'.
- Constructor Detail
  - ClassPathScanner(java.lang.String searchSpec)
    
    Builds a scanner for the given search spec.
    Parameters:
    searchSpec - The path format to search for. Supports only the format: 'folder/*.ext'.
  - ClassPathScanner()
- Method Detail
  - java.net.URL buildJarFileUrl(java.io.File file, java.lang.String path)
    
    Builds a jar file URL for the given jar file and path. @return
    Parameters:
    file - The .jar file.
    path - The
  - java.lang.String getJarFilePath(java.net.URL url)
    
    Gets the file name for the given JAR file URL.
    Parameters:
    url - The URL of the jar file to get.
    Returns:
    The path for the file.
  - java.lang.String getRootPath()
    
    Returns the root path for the desired resources.
    Returns:
    The root path. 'folder/*.ext' is converted to 'folder'.
  - java.lang.String match(java.net.URL url)
    
    Returns the portion of the given URL matches the desired search spec.
    Parameters:
    url - The URL to check.
    Returns:
    The matching portion.
  - java.lang.String match(java.lang.String url)
    
    Returns the portion of the given URL matches the desired search spec.
    Parameters:
    url - The string form of URL to check.
    Returns:
    The matching portion.
  - java.util.List scan()
    
    Scans the classpath for matching resources.
    Returns:
    The resource URLs or relative paths.
  - java.util.List scanFileFolder(java.io.File folder)
    
    Scan a file folder, including sub-folders.
    Parameters:
    folder - The folder to check.
    Returns:
    The matching resources found in the folder.
  - java.util.List scanJarFolder(java.io.File file)
    
    Scan a JAR file folder, including sub-folders.
    Parameters:
    url - The URL of the jar file to check.
    Returns:
    The matching resources found in the folder.
  - java.util.List scanResource(java.net.URL url)
    
    Scans a single resource for sub-elements that match the pattern.
    Parameters:
    url - The resource to check.
    Returns:
    Any sub-folder resources found.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ClassPathScanner

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private java.lang.ClassLoader classLoader

private static org.simplemes.eframe.misc.ClassPathScannerFactory factory

private java.util.regex.Pattern searchPattern

private java.lang.String searchSpec

Constructor Detail

ClassPathScanner(java.lang.String searchSpec)

ClassPathScanner()

Method Detail

java.net.URL buildJarFileUrl(java.io.File file, java.lang.String path)

java.lang.String getJarFilePath(java.net.URL url)

java.lang.String getRootPath()

java.lang.String match(java.net.URL url)

java.lang.String match(java.lang.String url)

java.util.List scan()

java.util.List scanFileFolder(java.io.File folder)

java.util.List scanJarFolder(java.io.File file)

java.util.List scanResource(java.net.URL url)