Enum Class Scanners

java.lang.Object

java.lang.Enum<Scanners>

org.reflections.scanners.Scanners

All Implemented Interfaces:

Serializable, Comparable<Scanners>, Constable, Scanner, NameHelper, QueryBuilder

public enum Scanners
extends Enum<Scanners>
implements Scanner, QueryBuilder, NameHelper

base Reflections Scanners such as:

• SubTypes
• TypesAnnotated
• MethodsAnnotated
• ConstructorsAnnotated
• FieldsAnnotated
• Resources
• MethodsParameter
• ConstructorsParameter
• MethodsSignature
• ConstructorsSignature
• MethodsReturn

note that scanners must be configured in Configuration in order to be queried

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ConstructorsAnnotated	scan constructor annotations
ConstructorsParameter	scan constructor parameters types and annotations
ConstructorsSignature	scan constructors signature
FieldsAnnotated	scan field annotations
MethodsAnnotated	scan method annotations
MethodsParameter	scan method parameters types and annotations
MethodsReturn	scan method return type
MethodsSignature	scan methods signature
Resources	scan non .class files such as xml or properties files
SubTypes	scan type superclasses and interfaces
TypesAnnotated	scan type annotations

Field Summary

Fields

Modifier and Type	Field	Description
private Predicate<String>	resultFilter

Fields inherited from interface NameHelper

primitiveDescriptors, primitiveNames, primitiveTypes

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Scanners()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptResult(String fqn)
Scanners	filterResultsBy(Predicate<String> filter)
String	index()	unique index name for scanner
final List<Map.Entry<String,String>>	scan(javassist.bytecode.ClassFile classFile)	scan the given classFile and produces list of Map.Entry key/values
(package private) abstract void	scan(javassist.bytecode.ClassFile classFile, List<Map.Entry<String,String>> entries)
static Scanners	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Scanners[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NameHelper

forClass, forConstructor, forElement, forField, forMember, forMethod, forName, forNames, forNames, toName, toName, toName, toName, toName, toNames, toNames

Methods inherited from interface QueryBuilder

get, get, get, getAll, getAllIncluding, getAllIncluding, of, of, of, of, of, with, with, with, with

Methods inherited from interface Scanner

acceptsInput, entries, entries, entries, entry, scan

Enum Constant Details

SubTypes

public static final Scanners SubTypes

scan type superclasses and interfaces

Note that Object class is excluded by default, in order to reduce store size.
Use filterResultsBy(Predicate) to change, for example SubTypes.filterResultsBy(c -> true)

TypesAnnotated

public static final Scanners TypesAnnotated

scan type annotations

MethodsAnnotated

public static final Scanners MethodsAnnotated

scan method annotations

ConstructorsAnnotated

public static final Scanners ConstructorsAnnotated

scan constructor annotations

FieldsAnnotated

public static final Scanners FieldsAnnotated

scan field annotations

Resources

public static final Scanners Resources

scan non .class files such as xml or properties files

MethodsParameter

public static final Scanners MethodsParameter

scan method parameters types and annotations

ConstructorsParameter

public static final Scanners ConstructorsParameter

scan constructor parameters types and annotations

MethodsSignature

public static final Scanners MethodsSignature

scan methods signature

ConstructorsSignature

public static final Scanners ConstructorsSignature

scan constructors signature

MethodsReturn

public static final Scanners MethodsReturn

scan method return type

Field Details

resultFilter

private Predicate<String> resultFilter

Constructor Details

Scanners

private Scanners()

Method Details

values

public static Scanners[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Scanners valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

index

public String index()

Description copied from interface: Scanner

unique index name for scanner

Specified by:

index in interface QueryBuilder

Specified by:

index in interface Scanner

filterResultsBy

public Scanners filterResultsBy(Predicate<String> filter)

scan

public final List<Map.Entry<String,String>> scan(javassist.bytecode.ClassFile classFile)

Description copied from interface: Scanner

scan the given classFile and produces list of Map.Entry key/values

Specified by:

scan in interface Scanner

scan

abstract void scan(javassist.bytecode.ClassFile classFile,
 List<Map.Entry<String,String>> entries)

acceptResult

protected boolean acceptResult(String fqn)