jodd.io.findfile

Class ClassScanner

java.lang.Object

jodd.io.findfile.ClassScanner

public class ClassScanner
extends java.lang.Object

Convenient class path scanner.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClassScanner.ClassPathEntry Provides input stream on demand.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	COMMONLY_EXCLUDED_ENTRIES
protected static java.lang.String[]	COMMONLY_EXCLUDED_JARS
protected boolean	detectEntriesMode
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[]	SYSTEM_JARS 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.
static ClassScanner	create() Create new class scanner.
ClassScanner	detectEntriesMode(boolean detectMode)
ClassScanner	excludeAllEntries(boolean whitelist) Sets white/black list mode for entries.
ClassScanner	excludeAllJars(boolean whitelist) Sets white/black list mode for jars.
ClassScanner	excludeCommonEntries() Excludes some commonly skipped packages.
ClassScanner	excludeCommonJars() Exclude some commonly unused 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.
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)
protected void	onEntry(ClassScanner.ClassPathEntry classPathEntry) 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.
ClassScanner	registerEntryConsumer(java.util.function.Consumer<ClassScanner.ClassPathEntry> entryDataConsumer) Registers a class path entry consumer.
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.ClassPathEntry classPathEntry) If entry name is accepted invokes onEntry(ClassPathEntry) a callback}.
protected void	scanJarFile(java.io.File file) Scans classes inside single JAR archive.
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

SYSTEM_JARS

protected static final java.lang.String[] SYSTEM_JARS

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

COMMONLY_EXCLUDED_JARS

protected static final java.lang.String[] COMMONLY_EXCLUDED_JARS

rulesJars

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

COMMONLY_EXCLUDED_ENTRIES

protected static final java.lang.String[] COMMONLY_EXCLUDED_ENTRIES

rulesEntries

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

detectEntriesMode

protected boolean detectEntriesMode

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

create

public static ClassScanner create()

Create new class scanner.

excludeJars

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

Specify excluded jars.

excludeCommonJars

public ClassScanner excludeCommonJars()

Exclude some commonly unused 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.

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

excludeCommonEntries

public ClassScanner excludeCommonEntries()

Excludes some commonly skipped packages.

detectEntriesMode

public ClassScanner detectEntriesMode(boolean detectMode)

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(ClassPathEntry)

scanClassPath

protected void scanClassPath(java.io.File root)

Scans single classpath directory.

See Also:

onEntry(ClassPathEntry)

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(ClassPathEntry)

scanEntry

protected void scanEntry(ClassScanner.ClassPathEntry classPathEntry)

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

registerEntryConsumer

public ClassScanner registerEntryConsumer(java.util.function.Consumer<ClassScanner.ClassPathEntry> entryDataConsumer)

Registers a class path entry consumer. It will be called on each loaded entry.

onEntry

protected void onEntry(ClassScanner.ClassPathEntry classPathEntry)

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.

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.