jodd.io.findfile

Class ClassScanner

java.lang.Object

jodd.io.findfile.ClassScanner

public class ClassScanner
extends java.lang.Object

Super class scanner.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassScanner.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,java.lang.String>	rulesEntries
protected InExRules<java.lang.String,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
ClassScanner()

Method Summary

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.
static byte[]	bytecodeSignatureOfType(java.lang.Class type) Returns type signature bytes used for searching in class file.
protected InExRules<java.lang.String,java.lang.String,java.lang.String>	createEntriesRules()
protected InExRules<java.lang.String,java.lang.String,java.lang.String>	createJarRules() Creates JAR rules.
ClassScanner	excludeAllEntries(boolean whitelist) Sets white/black list mode for entries.
ClassScanner	excludeAllJars(boolean whitelist) Sets white/black list mode for jars.
ClassScanner	excludeEntries(java.lang.String... excludedEntries) Sets excluded names that narrows included set of packages.
ClassScanner	excludeJars(java.lang.String... excludedJars) Specify excluded jars.
static ClassScanner	get()
ClassScanner	ignoreException(boolean ignoreException) Sets if exceptions during scanning process should be ignored or not.
ClassScanner	includeAllEntries(boolean blacklist) Sets white/black list mode for entries.
ClassScanner	includeAllJars(boolean blacklist) Sets white/black list mode for jars.
ClassScanner	includeEntries(java.lang.String... includedEntries) Sets included set of names that will be considered during configuration.
ClassScanner	includeJars(java.lang.String... includedJars) Specify included jars.
ClassScanner	includeResources(boolean includeResources)
java.lang.Class	loadClass(java.lang.String className) Loads class by its name.
protected void	onEntry(ClassScanner.EntryData entryData) Called during classpath scanning when class or resource is found.
ClassScanner	onEntry(java.util.function.Consumer<ClassScanner.EntryData> entryDataConsumer)
protected java.lang.String	prepareEntryName(java.lang.String name, boolean isClass) Prepares resource and class names.
ClassScanner	resetPaths() Resets all the paths previously added by some of scan methods.
ClassScanner	scan(java.io.File... paths) Scans provided paths.
ClassScanner	scan(java.lang.String... paths) Scans provided paths.
ClassScanner	scan(java.net.URL... urls) Scans URLs.
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.
ClassScanner	scanDefaultClasspath() Scans default class path.
protected void	scanEntry(ClassScanner.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.
ClassScanner	smartModeEntries()
void	start() Starts with the scanner.

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,java.lang.String> rulesJars

rulesEntries

protected final InExRules<java.lang.String,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

ClassScanner

public ClassScanner()

Method Detail

get

public static ClassScanner get()

createJarRules

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

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

excludeJars

public ClassScanner excludeJars(java.lang.String... excludedJars)

Specify excluded jars.

includeJars

public ClassScanner includeJars(java.lang.String... includedJars)

Specify included jars.

includeAllJars

public ClassScanner includeAllJars(boolean blacklist)

Sets white/black list mode for jars.

excludeAllJars

public ClassScanner excludeAllJars(boolean whitelist)

Sets white/black list mode for jars.

createEntriesRules

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

includeEntries

public ClassScanner includeEntries(java.lang.String... includedEntries)

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

See Also:

InExRules

includeAllEntries

public ClassScanner includeAllEntries(boolean blacklist)

Sets white/black list mode for entries.

excludeAllEntries

public ClassScanner excludeAllEntries(boolean whitelist)

Sets white/black list mode for entries.

excludeEntries

public ClassScanner excludeEntries(java.lang.String... excludedEntries)

Sets excluded names that narrows included set of packages.

See Also:

InExRules

smartModeEntries

public ClassScanner smartModeEntries()

includeResources

public ClassScanner includeResources(boolean includeResources)

ignoreException

public ClassScanner ignoreException(boolean ignoreException)

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

acceptJar

protected boolean acceptJar(java.io.File jarFile)

Returns true if some JAR file has to be accepted.

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(ClassScanner.EntryData entryData)

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

onEntry

public ClassScanner onEntry(java.util.function.Consumer<ClassScanner.EntryData> entryDataConsumer)

onEntry

protected void onEntry(ClassScanner.EntryData entryData)

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.

bytecodeSignatureOfType

public static byte[] bytecodeSignatureOfType(java.lang.Class type)

Returns type signature bytes used for searching in class file.

loadClass

public 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

resetPaths

public ClassScanner resetPaths()

Resets all the paths previously added by some of scan methods.

scan

public ClassScanner scan(java.net.URL... urls)

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

scanDefaultClasspath

public ClassScanner scanDefaultClasspath()

Scans default class path.

scan

public ClassScanner scan(java.io.File... paths)

Scans provided paths.

scan

public ClassScanner scan(java.lang.String... paths)

Scans provided paths.

start

public void start()

Starts with the scanner.