io.github.lukehutch.fastclasspathscanner.scanner

Class ScanSpec

java.lang.Object

io.github.lukehutch.fastclasspathscanner.scanner.ScanSpec

public class ScanSpec
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanSpec.FilePathTesterAndMatchProcessorWrapper
static class	ScanSpec.ScanSpecPathMatch Whether a path is a descendant of a blacklisted path, or an ancestor or descendant of a whitelisted path.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	blacklistSystemJars True if JRE system jarfiles (rt.jar etc.) should not be scanned.
boolean	blacklistSystemPackages By default, blacklist all java.* and sun.* packages.
HashSet<ClassLoaderHandler>	extraClassLoaderHandlers Manually-registered ClassLoaderHandlers.
boolean	ignoreFieldVisibility If true, ignore field visibility (affects finding classes with fields of a given type, and matching of static final fields with constant initializers).
String	overrideClasspath If non-null, specifies a classpath to override the default one.
boolean	scanJars True if jarfiles should be scanned.
boolean	scanNonJars True if non-jarfiles (directories) should be scanned.

Constructor Summary

Constructors

Constructor and Description
ScanSpec(String[] scanSpec)

Method Summary

Modifier and Type	Method and Description
void	addFilePathMatcher(io.github.lukehutch.fastclasspathscanner.scanner.FilePathTester filePathTester, io.github.lukehutch.fastclasspathscanner.scanner.FileMatchProcessorWrapper fileMatchProcessorWrapper)
boolean	blacklistSystemJars() True if JRE system jarfiles (rt.jar etc.) should not be scanned.
void	callMatchProcessors(ScanResult scanResult, LinkedBlockingQueue<io.github.lukehutch.fastclasspathscanner.scanner.ClasspathResource> matchingFiles, Map<String,ClassInfo> classNameToClassInfo, ThreadLog log) Run the MatchProcessors after a scan has completed.
void	checkClassIsNotBlacklisted(String className) Checks that the named class is not blacklisted.
boolean	classIsNotBlacklisted(String className) Returns true if the class is not specifically blacklisted, and is not within a blacklisted package.
String	getAnnotationName(Class<?> annotation) Check a class is an annotation, and that it is in a whitelisted package.
String[]	getAnnotationNames(Class<?>[] annotations) Check each element of an array of classes is an annotation, and that it is in a whitelisted package.
String	getClassName(Class<?> cls) Check a class is in a whitelisted package.
Map<String,HashSet<String>>	getClassNameToStaticFinalFieldsToMatch()
String	getClassOrInterfaceName(Class<?> classOrInterface) Check a class is a regular class or interface and not an annotation, and that it is in a whitelisted package.
String	getInterfaceName(Class<?> iface) Check a class is an interface, and that it is in a whitelisted package.
String[]	getInterfaceNames(Class<?>[] interfaces) Check each element of an array of classes is an interface, and that it is in a whitelisted package.
String	getStandardClassName(Class<?> cls) Check a class is a standard class (not an interface or annotation), and that it is in a whitelisted package.
boolean	isSpecificallyWhitelistedClass(String relativePath) Returns true if the given relative path (for a classfile name, including ".class") matches a specifically-whitelisted (and non-blacklisted) classfile's relative path.
boolean	jarIsWhitelisted(String jarName) Returns true if a jarfile is whitelisted and not blacklisted.
void	log(ThreadLog log)
void	matchAllAnnotationClasses(ClassMatchProcessor ClassMatchProcessor) Calls the provided ClassMatchProcessor for all annotation classes (annotation definitions) found in whitelisted packages on the classpath.
void	matchAllClasses(ClassMatchProcessor classMatchProcessor) Calls the provided ClassMatchProcessor for all standard classes, interfaces and annotations found in whitelisted packages on the classpath.
void	matchAllInterfaceClasses(ClassMatchProcessor ClassMatchProcessor) Calls the provided ClassMatchProcessor for all interface classes (interface definitions) found in whitelisted packages on the classpath.
void	matchAllStandardClasses(ClassMatchProcessor classMatchProcessor) Calls the provided ClassMatchProcessor for all standard classes (i.e.
<T> void	matchClassesImplementing(Class<T> implementedInterface, InterfaceMatchProcessor<T> interfaceMatchProcessor) Calls the provided InterfaceMatchProcessor for classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface.
void	matchClassesWithAnnotation(Class<?> annotation, ClassAnnotationMatchProcessor classAnnotationMatchProcessor) Calls the provided ClassMatchProcessor if classes are found on the classpath that have the specified annotation.
<T> void	matchClassesWithFieldOfType(Class<T> fieldType, ClassMatchProcessor classMatchProcessor) Calls the provided ClassMatchProcessor for classes on the classpath that have a field of the given type.
void	matchFilenameExtension(String extensionToMatch, FileMatchContentsProcessor fileMatchContentsProcessor) Calls the given FileMatchProcessor if files are found on the classpath that have the given file extension.
void	matchFilenameExtension(String extensionToMatch, FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext) Calls the given FileMatchProcessorWithContext if files are found on the classpath that have the given file extension.
void	matchFilenameExtension(String extensionToMatch, FileMatchProcessor fileMatchProcessor) Calls the given FileMatchProcessor if files are found on the classpath that have the given file extension.
void	matchFilenameExtension(String extensionToMatch, FileMatchProcessorWithContext fileMatchProcessorWithContext) Calls the given FileMatchProcessorWithContext if files are found on the classpath that have the given file extension.
void	matchFilenamePath(String relativePathToMatch, FileMatchContentsProcessor fileMatchContentsProcessor) Calls the given FileMatchContentsProcessor if files are found on the classpath that exactly match the given relative path.
void	matchFilenamePath(String relativePathToMatch, FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext) Calls the given FileMatchContentsProcessorWithContext if files are found on the classpath that exactly match the given relative path.
void	matchFilenamePath(String relativePathToMatch, FileMatchProcessor fileMatchProcessor) Calls the given FileMatchProcessor if files are found on the classpath that exactly match the given relative path.
void	matchFilenamePath(String relativePathToMatch, FileMatchProcessorWithContext fileMatchProcessorWithContext) Calls the given FileMatchProcessorWithContext if files are found on the classpath that exactly match the given relative path.
void	matchFilenamePathLeaf(String pathLeafToMatch, FileMatchContentsProcessor fileMatchContentsProcessor) Calls the given FileMatchContentsProcessor if files are found on the classpath that exactly match the given path leafname.
void	matchFilenamePathLeaf(String pathLeafToMatch, FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext) Calls the given FileMatchContentsProcessorWithContext if files are found on the classpath that exactly match the given path leafname.
void	matchFilenamePathLeaf(String pathLeafToMatch, FileMatchProcessor fileMatchProcessor) Calls the given FileMatchProcessor if files are found on the classpath that exactly match the given path leafname.
void	matchFilenamePathLeaf(String pathLeafToMatch, FileMatchProcessorWithContext fileMatchProcessorWithContext) Calls the given FileMatchProcessorWithContext if files are found on the classpath that exactly match the given path leafname.
void	matchFilenamePattern(String pathRegexp, FileMatchContentsProcessor fileMatchContentsProcessor) Calls the given FileMatchContentsProcessor if files are found on the classpath with the given regexp pattern in their path.
void	matchFilenamePattern(String pathRegexp, FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext) Calls the given FileMatchContentsProcessorWithContext if files are found on the classpath with the given regexp pattern in their path.
void	matchFilenamePattern(String pathRegexp, FileMatchProcessor fileMatchProcessor) Calls the given FileMatchProcessor if files are found on the classpath with the given regexp pattern in their path.
void	matchFilenamePattern(String pathRegexp, FileMatchProcessorWithContext fileMatchProcessorWithContext) Calls the given FileMatchProcessorWithContext if files are found on the classpath with the given regexp pattern in their path.
void	matchStaticFinalFieldNames(Set<String> fullyQualifiedStaticFinalFieldNames, StaticFinalFieldMatchProcessor staticFinalFieldMatchProcessor) Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match one of a set of fully-qualified field names, e.g.
void	matchStaticFinalFieldNames(String[] fullyQualifiedStaticFinalFieldNames, StaticFinalFieldMatchProcessor staticFinalFieldMatchProcessor) Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match one of a list of fully-qualified field names, e.g.
void	matchStaticFinalFieldNames(String fullyQualifiedStaticFinalFieldName, StaticFinalFieldMatchProcessor staticFinalFieldMatchProcessor) Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match a fully-qualified field name, e.g.
<T> void	matchSubclassesOf(Class<T> superclass, SubclassMatchProcessor<T> subclassMatchProcessor) Calls the provided SubclassMatchProcessor if classes are found on the classpath that extend the specified superclass.
<T> void	matchSubinterfacesOf(Class<T> superinterface, SubinterfaceMatchProcessor<T> subinterfaceMatchProcessor) Calls the provided SubinterfaceMatchProcessor if an interface that extends a given superinterface is found on the classpath.
ScanSpec.ScanSpecPathMatch	pathWhitelistMatchStatus(String relativePath) Returns true if the given directory path is a descendant of a blacklisted path, or an ancestor or descendant of a whitelisted path.

Methods inherited from class java.lang.Object

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

Field Detail

scanJars

public final boolean scanJars

True if jarfiles should be scanned.

scanNonJars

public final boolean scanNonJars

True if non-jarfiles (directories) should be scanned.

overrideClasspath

public String overrideClasspath

If non-null, specifies a classpath to override the default one.

extraClassLoaderHandlers

public final HashSet<ClassLoaderHandler> extraClassLoaderHandlers

Manually-registered ClassLoaderHandlers.

blacklistSystemJars

public boolean blacklistSystemJars

True if JRE system jarfiles (rt.jar etc.) should not be scanned. By default, these are not scanned. This can be overridden by including "!!" in the scan spec. Disabling this blacklisting will increase the time or memory required to scan the classpath.

blacklistSystemPackages

public boolean blacklistSystemPackages

By default, blacklist all java.* and sun.* packages. This means for example that you can't use java.lang.Comparable as a match criterion. This can be overridden by including "!!" in the scan spec. Disabling this blacklisting may increase the time or memory required to scan the classpath.

ignoreFieldVisibility

public boolean ignoreFieldVisibility

If true, ignore field visibility (affects finding classes with fields of a given type, and matching of static final fields with constant initializers). If false, fields must be public to be indexed/matched.

Constructor Detail

ScanSpec

public ScanSpec(String[] scanSpec)

Method Detail

getClassNameToStaticFinalFieldsToMatch

public Map<String,HashSet<String>> getClassNameToStaticFinalFieldsToMatch()

log

public void log(ThreadLog log)

callMatchProcessors

public void callMatchProcessors(ScanResult scanResult,
                                LinkedBlockingQueue<io.github.lukehutch.fastclasspathscanner.scanner.ClasspathResource> matchingFiles,
                                Map<String,ClassInfo> classNameToClassInfo,
                                ThreadLog log)
                         throws InterruptedException

Run the MatchProcessors after a scan has completed.

Throws:

InterruptedException

pathWhitelistMatchStatus

public ScanSpec.ScanSpecPathMatch pathWhitelistMatchStatus(String relativePath)

Returns true if the given directory path is a descendant of a blacklisted path, or an ancestor or descendant of a whitelisted path. The path should end in "/".

isSpecificallyWhitelistedClass

public boolean isSpecificallyWhitelistedClass(String relativePath)

Returns true if the given relative path (for a classfile name, including ".class") matches a specifically-whitelisted (and non-blacklisted) classfile's relative path.

classIsNotBlacklisted

public boolean classIsNotBlacklisted(String className)

Returns true if the class is not specifically blacklisted, and is not within a blacklisted package.

checkClassIsNotBlacklisted

public void checkClassIsNotBlacklisted(String className)

Checks that the named class is not blacklisted. Throws IllegalArgumentException otherwise.

jarIsWhitelisted

public boolean jarIsWhitelisted(String jarName)

Returns true if a jarfile is whitelisted and not blacklisted.

blacklistSystemJars

public boolean blacklistSystemJars()

True if JRE system jarfiles (rt.jar etc.) should not be scanned. By default, these are not scanned. This can be overridden by including "!!" in the scan spec. Disabling this blacklisting will increase the time or memory required to scan the classpath.

getAnnotationName

public String getAnnotationName(Class<?> annotation)

Check a class is an annotation, and that it is in a whitelisted package. Throws IllegalArgumentException otherwise. Returns the name of the annotation.

getAnnotationNames

public String[] getAnnotationNames(Class<?>[] annotations)

Check each element of an array of classes is an annotation, and that it is in a whitelisted package. Throws IllegalArgumentException otherwise. Returns the names of the classes as an array of strings.

getInterfaceName

public String getInterfaceName(Class<?> iface)

Check a class is an interface, and that it is in a whitelisted package. Throws IllegalArgumentException otherwise. Returns the name of the interface.

getInterfaceNames

public String[] getInterfaceNames(Class<?>[] interfaces)

Check each element of an array of classes is an interface, and that it is in a whitelisted package. Throws IllegalArgumentException otherwise. Returns the names of the classes as an array of strings.

getClassOrInterfaceName

public String getClassOrInterfaceName(Class<?> classOrInterface)

Check a class is a regular class or interface and not an annotation, and that it is in a whitelisted package. Throws IllegalArgumentException otherwise. Returns the name of the class or interface.

getStandardClassName

public String getStandardClassName(Class<?> cls)

Check a class is a standard class (not an interface or annotation), and that it is in a whitelisted package. Returns the name of the class if it is a standard class and it is in a whitelisted package, otherwise throws an IllegalArgumentException.

getClassName

public String getClassName(Class<?> cls)

Check a class is in a whitelisted package. Returns the name of the class if it is in a whitelisted package, otherwise throws an IllegalArgumentException.

matchAllClasses

public void matchAllClasses(ClassMatchProcessor classMatchProcessor)

Calls the provided ClassMatchProcessor for all standard classes, interfaces and annotations found in whitelisted packages on the classpath. Calls the class loader on each matching class (using Class.forName()) before calling the ClassMatchProcessor.

Parameters:

classMatchProcessor - the ClassMatchProcessor to call when a match is found.

matchAllStandardClasses

public void matchAllStandardClasses(ClassMatchProcessor classMatchProcessor)

Calls the provided ClassMatchProcessor for all standard classes (i.e. non-interface, non-annotation classes) found in whitelisted packages on the classpath. Calls the class loader on each matching class (using Class.forName()) before calling the ClassMatchProcessor.

Parameters:

classMatchProcessor - the ClassMatchProcessor to call when a match is found.

matchAllInterfaceClasses

public void matchAllInterfaceClasses(ClassMatchProcessor ClassMatchProcessor)

Calls the provided ClassMatchProcessor for all interface classes (interface definitions) found in whitelisted packages on the classpath. Calls the class loader on each matching interface class (using Class.forName()) before calling the ClassMatchProcessor.

Parameters:

ClassMatchProcessor - the ClassMatchProcessor to call when a match is found.

matchAllAnnotationClasses

public void matchAllAnnotationClasses(ClassMatchProcessor ClassMatchProcessor)

Calls the provided ClassMatchProcessor for all annotation classes (annotation definitions) found in whitelisted packages on the classpath. Calls the class loader on each matching annotation class (using Class.forName()) before calling the ClassMatchProcessor.

Parameters:

ClassMatchProcessor - the ClassMatchProcessor to call when a match is found.

matchSubclassesOf

public <T> void matchSubclassesOf(Class<T> superclass,
                                  SubclassMatchProcessor<T> subclassMatchProcessor)

Calls the provided SubclassMatchProcessor if classes are found on the classpath that extend the specified superclass. Calls the class loader on each matching class (using Class.forName()) before calling the SubclassMatchProcessor. Does not call the classloader on non-matching classes or interfaces.

Parameters:

superclass - The superclass to match (i.e. the class that subclasses need to extend to match).

subclassMatchProcessor - the SubclassMatchProcessor to call when a match is found.

matchSubinterfacesOf

public <T> void matchSubinterfacesOf(Class<T> superinterface,
                                     SubinterfaceMatchProcessor<T> subinterfaceMatchProcessor)

Calls the provided SubinterfaceMatchProcessor if an interface that extends a given superinterface is found on the classpath. Will call the class loader on each matching interface (using Class.forName()) before calling the SubinterfaceMatchProcessor. Does not call the classloader on non-matching classes or interfaces.

Parameters:

superinterface - The superinterface to match (i.e. the interface that subinterfaces need to extend to match).

subinterfaceMatchProcessor - the SubinterfaceMatchProcessor to call when a match is found.

matchClassesImplementing

public <T> void matchClassesImplementing(Class<T> implementedInterface,
                                         InterfaceMatchProcessor<T> interfaceMatchProcessor)

Calls the provided InterfaceMatchProcessor for classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface. Will call the class loader on each matching interface (using Class.forName()) before calling the InterfaceMatchProcessor. Does not call the classloader on non-matching classes or interfaces.

Parameters:

implementedInterface - The interface that classes need to implement.

interfaceMatchProcessor - the ClassMatchProcessor to call when a match is found.

matchClassesWithFieldOfType

public <T> void matchClassesWithFieldOfType(Class<T> fieldType,
                                            ClassMatchProcessor classMatchProcessor)

Calls the provided ClassMatchProcessor for classes on the classpath that have a field of the given type. Matches classes that have fields of the given type, array fields with an element type of the given type, and fields of parameterized type that have a type parameter of the given type. (Does not call the classloader on non-matching classes.) The field type must be declared in a package that is whitelisted (and not blacklisted).

Parameters:

fieldType - The type of the field to match..

classMatchProcessor - the ClassMatchProcessor to call when a match is found.

matchClassesWithAnnotation

public void matchClassesWithAnnotation(Class<?> annotation,
                                       ClassAnnotationMatchProcessor classAnnotationMatchProcessor)

Calls the provided ClassMatchProcessor if classes are found on the classpath that have the specified annotation.

Parameters:

annotation - The class annotation to match.

classAnnotationMatchProcessor - the ClassAnnotationMatchProcessor to call when a match is found.

matchStaticFinalFieldNames

public void matchStaticFinalFieldNames(Set<String> fullyQualifiedStaticFinalFieldNames,
                                       StaticFinalFieldMatchProcessor staticFinalFieldMatchProcessor)

Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match one of a set of fully-qualified field names, e.g. "com.package.ClassName.STATIC_FIELD_NAME". Field values are obtained from the constant pool in classfiles, *not* from a loaded class using reflection. This allows you to detect changes to the classpath and then run another scan that picks up the new values of selected static constants without reloading the class. (Class reloading is fraught with issues, see: http://tutorials.jenkov.com/java-reflection/dynamic-class-loading-reloading.html ) Note: Only static final fields with constant-valued literals are matched, not fields with initializer values that are the result of an expression or reference, except for cases where the compiler is able to simplify an expression into a single constant at compiletime, such as in the case of string concatenation. Note that the visibility of the fields is not checked; the value of the field in the classfile is returned whether or not it should be visible to the caller.

Parameters:

fullyQualifiedStaticFinalFieldNames - The set of fully-qualified static field names to match.

staticFinalFieldMatchProcessor - the StaticFinalFieldMatchProcessor to call when a match is found.

matchStaticFinalFieldNames

public void matchStaticFinalFieldNames(String fullyQualifiedStaticFinalFieldName,
                                       StaticFinalFieldMatchProcessor staticFinalFieldMatchProcessor)

Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match a fully-qualified field name, e.g. "com.package.ClassName.STATIC_FIELD_NAME". Field values are obtained from the constant pool in classfiles, *not* from a loaded class using reflection. This allows you to detect changes to the classpath and then run another scan that picks up the new values of selected static constants without reloading the class. (Class reloading is fraught with issues, see: http://tutorials.jenkov.com/java-reflection/dynamic-class-loading-reloading.html ) Note: Only static final fields with constant-valued literals are matched, not fields with initializer values that are the result of an expression or reference, except for cases where the compiler is able to simplify an expression into a single constant at compiletime, such as in the case of string concatenation. Note that the visibility of the fields is not checked; the value of the field in the classfile is returned whether or not it should be visible to the caller.

Parameters:

fullyQualifiedStaticFinalFieldName - The fully-qualified static field name to match

staticFinalFieldMatchProcessor - the StaticFinalFieldMatchProcessor to call when a match is found.

matchStaticFinalFieldNames

public void matchStaticFinalFieldNames(String[] fullyQualifiedStaticFinalFieldNames,
                                       StaticFinalFieldMatchProcessor staticFinalFieldMatchProcessor)

Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match one of a list of fully-qualified field names, e.g. "com.package.ClassName.STATIC_FIELD_NAME". Field values are obtained from the constant pool in classfiles, *not* from a loaded class using reflection. This allows you to detect changes to the classpath and then run another scan that picks up the new values of selected static constants without reloading the class. (Class reloading is fraught with issues, see: http://tutorials.jenkov.com/java-reflection/dynamic-class-loading-reloading.html ) Note: Only static final fields with constant-valued literals are matched, not fields with initializer values that are the result of an expression or reference, except for cases where the compiler is able to simplify an expression into a single constant at compiletime, such as in the case of string concatenation. Note that the visibility of the fields is not checked; the value of the field in the classfile is returned whether or not it should be visible to the caller.

Parameters:

fullyQualifiedStaticFinalFieldNames - The list of fully-qualified static field names to match.

staticFinalFieldMatchProcessor - the StaticFinalFieldMatchProcessor to call when a match is found.

addFilePathMatcher

public void addFilePathMatcher(io.github.lukehutch.fastclasspathscanner.scanner.FilePathTester filePathTester,
                               io.github.lukehutch.fastclasspathscanner.scanner.FileMatchProcessorWrapper fileMatchProcessorWrapper)

matchFilenamePattern

public void matchFilenamePattern(String pathRegexp,
                                 FileMatchProcessorWithContext fileMatchProcessorWithContext)

Calls the given FileMatchProcessorWithContext if files are found on the classpath with the given regexp pattern in their path.

Parameters:

pathRegexp - The regexp to match, e.g. "app/templates/.\*\.html"

fileMatchProcessorWithContext - The FileMatchProcessorWithContext to call when each match is found.

matchFilenamePattern

public void matchFilenamePattern(String pathRegexp,
                                 FileMatchProcessor fileMatchProcessor)

Calls the given FileMatchProcessor if files are found on the classpath with the given regexp pattern in their path.

Parameters:

pathRegexp - The regexp to match, e.g. "app/templates/.\*\.html"

fileMatchProcessor - The FileMatchProcessor to call when each match is found.

matchFilenamePattern

public void matchFilenamePattern(String pathRegexp,
                                 FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext)

Calls the given FileMatchContentsProcessorWithContext if files are found on the classpath with the given regexp pattern in their path.

Parameters:

pathRegexp - The regexp to match, e.g. "app/templates/.\*\.html"

fileMatchContentsProcessorWithContext - The FileMatchContentsProcessorWithContext to call when each match is found.

matchFilenamePattern

public void matchFilenamePattern(String pathRegexp,
                                 FileMatchContentsProcessor fileMatchContentsProcessor)

Calls the given FileMatchContentsProcessor if files are found on the classpath with the given regexp pattern in their path.

Parameters:

pathRegexp - The regexp to match, e.g. "app/templates/.\*\.html"

fileMatchContentsProcessor - The FileMatchContentsProcessor to call when each match is found.

matchFilenamePath

public void matchFilenamePath(String relativePathToMatch,
                              FileMatchProcessorWithContext fileMatchProcessorWithContext)

Calls the given FileMatchProcessorWithContext if files are found on the classpath that exactly match the given relative path.

Parameters:

relativePathToMatch - The complete path to match relative to the classpath entry, e.g. "app/templates/WidgetTemplate.html"

fileMatchProcessorWithContext - The FileMatchProcessorWithContext to call when each match is found.

matchFilenamePath

public void matchFilenamePath(String relativePathToMatch,
                              FileMatchProcessor fileMatchProcessor)

Calls the given FileMatchProcessor if files are found on the classpath that exactly match the given relative path.

Parameters:

relativePathToMatch - The complete path to match relative to the classpath entry, e.g. "app/templates/WidgetTemplate.html"

fileMatchProcessor - The FileMatchProcessor to call when each match is found.

matchFilenamePath

public void matchFilenamePath(String relativePathToMatch,
                              FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext)

Calls the given FileMatchContentsProcessorWithContext if files are found on the classpath that exactly match the given relative path.

Parameters:

relativePathToMatch - The complete path to match relative to the classpath entry, e.g. "app/templates/WidgetTemplate.html"

fileMatchContentsProcessorWithContext - The FileMatchContentsProcessorWithContext to call when each match is found.

matchFilenamePath

public void matchFilenamePath(String relativePathToMatch,
                              FileMatchContentsProcessor fileMatchContentsProcessor)

Calls the given FileMatchContentsProcessor if files are found on the classpath that exactly match the given relative path.

Parameters:

relativePathToMatch - The complete path to match relative to the classpath entry, e.g. "app/templates/WidgetTemplate.html"

fileMatchContentsProcessor - The FileMatchContentsProcessor to call when each match is found.

matchFilenamePathLeaf

public void matchFilenamePathLeaf(String pathLeafToMatch,
                                  FileMatchProcessorWithContext fileMatchProcessorWithContext)

Calls the given FileMatchProcessorWithContext if files are found on the classpath that exactly match the given path leafname.

Parameters:

pathLeafToMatch - The complete path leaf to match, e.g. "WidgetTemplate.html"

fileMatchProcessorWithContext - The FileMatchProcessorWithContext to call when each match is found.

matchFilenamePathLeaf

public void matchFilenamePathLeaf(String pathLeafToMatch,
                                  FileMatchProcessor fileMatchProcessor)

Calls the given FileMatchProcessor if files are found on the classpath that exactly match the given path leafname.

Parameters:

pathLeafToMatch - The complete path leaf to match, e.g. "WidgetTemplate.html"

fileMatchProcessor - The FileMatchProcessor to call when each match is found.

matchFilenamePathLeaf

public void matchFilenamePathLeaf(String pathLeafToMatch,
                                  FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext)

Calls the given FileMatchContentsProcessorWithContext if files are found on the classpath that exactly match the given path leafname.

Parameters:

pathLeafToMatch - The complete path leaf to match, e.g. "WidgetTemplate.html"

fileMatchContentsProcessorWithContext - The FileMatchContentsProcessorWithContext to call when each match is found.

matchFilenamePathLeaf

public void matchFilenamePathLeaf(String pathLeafToMatch,
                                  FileMatchContentsProcessor fileMatchContentsProcessor)

Calls the given FileMatchContentsProcessor if files are found on the classpath that exactly match the given path leafname.

Parameters:

pathLeafToMatch - The complete path leaf to match, e.g. "WidgetTemplate.html"

fileMatchContentsProcessor - The FileMatchContentsProcessor to call when each match is found.

matchFilenameExtension

public void matchFilenameExtension(String extensionToMatch,
                                   FileMatchProcessorWithContext fileMatchProcessorWithContext)

Calls the given FileMatchProcessorWithContext if files are found on the classpath that have the given file extension.

Parameters:

extensionToMatch - The extension to match, e.g. "html" matches "WidgetTemplate.html" and "WIDGET.HTML".

fileMatchProcessorWithContext - The FileMatchProcessorWithContext to call when each match is found.

matchFilenameExtension

public void matchFilenameExtension(String extensionToMatch,
                                   FileMatchProcessor fileMatchProcessor)

Calls the given FileMatchProcessor if files are found on the classpath that have the given file extension.

Parameters:

extensionToMatch - The extension to match, e.g. "html" matches "WidgetTemplate.html" and "WIDGET.HTML".

fileMatchProcessor - The FileMatchProcessor to call when each match is found.

matchFilenameExtension

public void matchFilenameExtension(String extensionToMatch,
                                   FileMatchContentsProcessorWithContext fileMatchContentsProcessorWithContext)

Calls the given FileMatchProcessorWithContext if files are found on the classpath that have the given file extension.

Parameters:

extensionToMatch - The extension to match, e.g. "html" matches "WidgetTemplate.html".

fileMatchContentsProcessorWithContext - The FileMatchContentsProcessorWithContext to call when each match is found.

matchFilenameExtension

public void matchFilenameExtension(String extensionToMatch,
                                   FileMatchContentsProcessor fileMatchContentsProcessor)

Calls the given FileMatchProcessor if files are found on the classpath that have the given file extension.

Parameters:

extensionToMatch - The extension to match, e.g. "html" matches "WidgetTemplate.html".

fileMatchContentsProcessor - The FileMatchContentsProcessor to call when each match is found.