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.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	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[] scanSpecs)

Method Summary

Modifier and Type	Method and Description
boolean	classIsNotBlacklisted(String className) Returns true if the class is not specifically blacklisted, and is not within a blacklisted 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.
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.

Constructor Detail

ScanSpec

public ScanSpec(String[] scanSpecs)

Method Detail

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.

jarIsWhitelisted

public boolean jarIsWhitelisted(String jarName)

Returns true if a jarfile is whitelisted and not blacklisted.