nonapi.io.github.classgraph.scanspec

Enum ScanSpec.ScanSpecPathMatch

java.lang.Object

java.lang.Enum<ScanSpec.ScanSpecPathMatch>

nonapi.io.github.classgraph.scanspec.ScanSpec.ScanSpecPathMatch

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScanSpec.ScanSpecPathMatch>

Enclosing class:

ScanSpec

public static enum ScanSpec.ScanSpecPathMatch
extends java.lang.Enum<ScanSpec.ScanSpecPathMatch>

Whether a path is a descendant of a rejected path, or an ancestor or descendant of an accepted path.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANCESTOR_OF_ACCEPTED_PATH Path is an ancestor of an accepted path.
AT_ACCEPTED_CLASS_PACKAGE Path is the package of a specifically-accepted class.
AT_ACCEPTED_PATH Path is accepted.
HAS_ACCEPTED_PATH_PREFIX Path starts with an accepted path prefix.
HAS_REJECTED_PATH_PREFIX Path starts with (or is) a rejected path prefix.
NOT_WITHIN_ACCEPTED_PATH Path is not accepted and not rejected.

Method Summary

Modifier and Type	Method and Description
static ScanSpec.ScanSpecPathMatch	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScanSpec.ScanSpecPathMatch[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HAS_REJECTED_PATH_PREFIX

public static final ScanSpec.ScanSpecPathMatch HAS_REJECTED_PATH_PREFIX

Path starts with (or is) a rejected path prefix.

HAS_ACCEPTED_PATH_PREFIX

public static final ScanSpec.ScanSpecPathMatch HAS_ACCEPTED_PATH_PREFIX

Path starts with an accepted path prefix.

AT_ACCEPTED_PATH

public static final ScanSpec.ScanSpecPathMatch AT_ACCEPTED_PATH

Path is accepted.

ANCESTOR_OF_ACCEPTED_PATH

public static final ScanSpec.ScanSpecPathMatch ANCESTOR_OF_ACCEPTED_PATH

Path is an ancestor of an accepted path.

AT_ACCEPTED_CLASS_PACKAGE

public static final ScanSpec.ScanSpecPathMatch AT_ACCEPTED_CLASS_PACKAGE

Path is the package of a specifically-accepted class.

NOT_WITHIN_ACCEPTED_PATH

public static final ScanSpec.ScanSpecPathMatch NOT_WITHIN_ACCEPTED_PATH

Path is not accepted and not rejected.

Method Detail

values

public static ScanSpec.ScanSpecPathMatch[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScanSpec.ScanSpecPathMatch c : ScanSpec.ScanSpecPathMatch.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScanSpec.ScanSpecPathMatch valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null