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 given class name is not blacklisted or is explicitly whitelisted.
boolean	classIsWhitelisted(String className) Returns true if the given class name is whitelisted and not blacklisted, or if it is in a whitelisted, non-blacklisted package.
boolean	jarIsWhitelisted(String jarName) Returns true if a jarfile is whitelisted and not blacklisted.
boolean	pathIsWhitelisted(String relativePath) Returns true if the given path is within a whitelisted, non-blacklisted package.
ScanSpec.ScanSpecPathMatch	pathWhitelistMatchStatus(String path) See whether the given 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

classIsNotBlacklisted

public boolean classIsNotBlacklisted(String className)

Returns true if the given class name is not blacklisted or is explicitly whitelisted. This does not apply the normal logic of "if (whitelisted && !blacklisted)", but instead "if (whitelisted || !blacklisted)", because it is used for links that may come from outside a whitelisted path, but still may need to be used as a query criterion (e.g. a class name to match against, or a field type to look up containing classes from).

classIsWhitelisted

public boolean classIsWhitelisted(String className)

Returns true if the given class name is whitelisted and not blacklisted, or if it is in a whitelisted, non-blacklisted package. This does not apply the normal logic of "if (whitelisted && !blacklisted)", but instead "if (whitelisted || !blacklisted)", because it is used for links that may come from outside a whitelisted path, but still may need to be used as a query criterion (e.g. a class name to match against, or a field type to look up containing classes from).

pathIsWhitelisted

public boolean pathIsWhitelisted(String relativePath)

Returns true if the given path is within a whitelisted, non-blacklisted package.

pathWhitelistMatchStatus

public ScanSpec.ScanSpecPathMatch pathWhitelistMatchStatus(String path)

See whether the given path is a descendant of a blacklisted path, or an ancestor or descendant of a whitelisted path. The path should end in "/".

jarIsWhitelisted

public boolean jarIsWhitelisted(String jarName)

Returns true if a jarfile is whitelisted and not blacklisted.