jodd.io.findfile

Class ClassFinder

java.lang.Object

jodd.io.findfile.ClassFinder

Direct Known Subclasses:

ClassScanner

public abstract class ClassFinder
extends java.lang.Object

Simple utility that scans URLs for classes. Its purpose is to help scanning class paths for some classes. Content of Jar files is also examined.

Scanning starts in included all mode (blacklist mode) for both jars and lists. User can set explicit excludes. Of course, mode can be changed.

All paths are matched using path-style wildcard matcher. All entries are matched using Wildcard.match(CharSequence, CharSequence) common-style} wildcard matcher.

See Also:

ClassScanner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ClassFinder.EntryData Provides input stream on demand.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ignoreException If set to true exceptions for entry scans are ignored.
protected boolean	includeResources If set to true all files will be scanned and not only classes.
protected InExRules<java.lang.String,java.lang.String>	rulesEntries
protected InExRules<java.lang.String,java.lang.String>	rulesJars
protected static java.lang.String[]	systemJars Array of system jars that are excluded from the search.

Constructor Summary

Constructors

Constructor and Description
ClassFinder()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	acceptEntry(java.lang.String entryName) Returns true if some entry name has to be accepted.
protected boolean	acceptJar(java.io.File jarFile) Returns true if some JAR file has to be accepted.
protected InExRules<java.lang.String,java.lang.String>	createEntriesRules()
protected InExRules<java.lang.String,java.lang.String>	createJarRules() Creates JAR rules.
static java.lang.String[]	getSystemJars() Returns system jars.
protected byte[]	getTypeSignatureBytes(java.lang.Class type) Returns type signature bytes used for searching in class file.
boolean	isIgnoreException()
boolean	isIncludeResources()
protected boolean	isTypeSignatureInUse(java.io.InputStream inputStream, byte[] bytes) Returns true if class contains type signature.
protected java.lang.Class	loadClass(java.lang.String className) Loads class by its name.
protected abstract void	onEntry(ClassFinder.EntryData entryData) Called during classpath scanning when class or resource is found.
protected java.lang.String	prepareEntryName(java.lang.String name, boolean isClass) Prepares resource and class names.
protected void	scanClassFile(java.lang.String filePath, java.lang.String rootPath, java.io.File file, boolean isClass)
protected void	scanClassPath(java.io.File root) Scans single classpath directory.
protected void	scanEntry(ClassFinder.EntryData entryData) If entry name is accepted invokes onEntry(EntryData) a callback}.
protected void	scanJarFile(java.io.File file) Scans classes inside single JAR archive.
protected void	scanPath(java.io.File file) Scans single path.
protected void	scanPath(java.lang.String path)
protected void	scanPaths(java.io.File... paths)
protected void	scanPaths(java.lang.String... paths)
protected void	scanUrl(java.net.URL url) Scans single URL for classes and jar files.
protected void	scanUrls(java.net.URL... urls) Scans several URLs.
void	setExcludeAllEntries(boolean whitelist) Sets white/black list mode for entries.
void	setExcludeAllJars(boolean whitelist) Sets white/black list mode for jars.
void	setExcludedEntries(java.lang.String... excludedEntries) Sets excluded names that narrows included set of packages.
void	setExcludedJars(java.lang.String... excludedJars) Specify excluded jars.
void	setIgnoreException(boolean ignoreException) Sets if exceptions during scanning process should be ignored or not.
void	setIncludeAllEntries(boolean blacklist) Sets white/black list mode for entries.
void	setIncludeAllJars(boolean blacklist) Sets white/black list mode for jars.
void	setIncludedEntries(java.lang.String... includedEntries) Sets included set of names that will be considered during configuration.
void	setIncludedJars(java.lang.String... includedJars) Specify included jars.
void	setIncludeResources(boolean includeResources)

Methods inherited from class java.lang.Object

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

Field Detail

systemJars

protected static java.lang.String[] systemJars

Array of system jars that are excluded from the search. By default, these paths are common for linux, windows and mac.

rulesJars

protected final InExRules<java.lang.String,java.lang.String> rulesJars

rulesEntries

protected final InExRules<java.lang.String,java.lang.String> rulesEntries

includeResources

protected boolean includeResources

If set to true all files will be scanned and not only classes.

ignoreException

protected boolean ignoreException

If set to true exceptions for entry scans are ignored.

Constructor Detail

ClassFinder

public ClassFinder()

Method Detail

createJarRules

protected InExRules<java.lang.String,java.lang.String> createJarRules()

Creates JAR rules. By default, excludes all system jars.

getSystemJars

public static java.lang.String[] getSystemJars()

Returns system jars.

setExcludedJars

public void setExcludedJars(java.lang.String... excludedJars)

Specify excluded jars.

setIncludedJars

public void setIncludedJars(java.lang.String... includedJars)

Specify included jars.

setIncludeAllJars

public void setIncludeAllJars(boolean blacklist)

Sets white/black list mode for jars.

setExcludeAllJars

public void setExcludeAllJars(boolean whitelist)

Sets white/black list mode for jars.

createEntriesRules

protected InExRules<java.lang.String,java.lang.String> createEntriesRules()

setIncludedEntries

public void setIncludedEntries(java.lang.String... includedEntries)

Sets included set of names that will be considered during configuration.

See Also:

InExRules

setIncludeAllEntries

public void setIncludeAllEntries(boolean blacklist)

Sets white/black list mode for entries.

setExcludeAllEntries

public void setExcludeAllEntries(boolean whitelist)

Sets white/black list mode for entries.

setExcludedEntries

public void setExcludedEntries(java.lang.String... excludedEntries)

Sets excluded names that narrows included set of packages.

See Also:

InExRules

isIncludeResources

public boolean isIncludeResources()

setIncludeResources

public void setIncludeResources(boolean includeResources)

isIgnoreException

public boolean isIgnoreException()

setIgnoreException

public void setIgnoreException(boolean ignoreException)

Sets if exceptions during scanning process should be ignored or not.

scanUrls

protected void scanUrls(java.net.URL... urls)

Scans several URLs. If (#ignoreExceptions} is set, exceptions per one URL will be ignored and loops continues.

scanUrl

protected void scanUrl(java.net.URL url)

Scans single URL for classes and jar files. Callback onEntry(EntryData) is called on each class name.

scanPaths

protected void scanPaths(java.io.File... paths)

scanPaths

protected void scanPaths(java.lang.String... paths)

scanPath

protected void scanPath(java.lang.String path)

acceptJar

protected boolean acceptJar(java.io.File jarFile)

Returns true if some JAR file has to be accepted.

scanPath

protected void scanPath(java.io.File file)

Scans single path.

scanJarFile

protected void scanJarFile(java.io.File file)

Scans classes inside single JAR archive. Archive is scanned as a zip file.

See Also:

onEntry(EntryData)

scanClassPath

protected void scanClassPath(java.io.File root)

Scans single classpath directory.

See Also:

onEntry(EntryData)

scanClassFile

protected void scanClassFile(java.lang.String filePath,
                 java.lang.String rootPath,
                 java.io.File file,
                 boolean isClass)

prepareEntryName

protected java.lang.String prepareEntryName(java.lang.String name,
                                boolean isClass)

Prepares resource and class names. For classes, it strips '.class' from the end and converts all (back)slashes to dots. For resources, it replaces all backslashes to slashes.

acceptEntry

protected boolean acceptEntry(java.lang.String entryName)

Returns true if some entry name has to be accepted.

See Also:

prepareEntryName(String, boolean), scanEntry(EntryData)

scanEntry

protected void scanEntry(ClassFinder.EntryData entryData)

If entry name is accepted invokes onEntry(EntryData) a callback}.

onEntry

protected abstract void onEntry(ClassFinder.EntryData entryData)
                         throws java.lang.Exception

Called during classpath scanning when class or resource is found.

• Class name is java-alike class name (pk1.pk2.class) that may be immediately used for dynamic loading.
• Resource name starts with '\' and represents either jar path (\pk1/pk2/res) or relative file path (\pk1\pk2\res).

InputStream is provided by InputStreamProvider and opened lazy. Once opened, input stream doesn't have to be closed - this is done by this class anyway.

Throws:

java.lang.Exception

getTypeSignatureBytes

protected byte[] getTypeSignatureBytes(java.lang.Class type)

Returns type signature bytes used for searching in class file.

isTypeSignatureInUse

protected boolean isTypeSignatureInUse(java.io.InputStream inputStream,
                           byte[] bytes)

Returns true if class contains type signature. It searches the class content for bytecode signature. This is the fastest way of finding if come class uses some type. Please note that if signature exists it still doesn't means that class uses it in expected way, therefore, class should be loaded to complete the scan.

loadClass

protected java.lang.Class loadClass(java.lang.String className)
                             throws java.lang.ClassNotFoundException

Loads class by its name. If ignoreException is set, no exception is thrown, but null is returned.

Throws:

java.lang.ClassNotFoundException