org.reflections.scanners

Enum Scanners

java.lang.Object

java.lang.Enum<Scanners>

org.reflections.scanners.Scanners

All Implemented Interfaces:

Serializable, Comparable<Scanners>, 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

Enum Constant Summary

Enum Constants

Enum Constant and 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 inherited from interface org.reflections.util.NameHelper

primitiveDescriptors, primitiveNames, primitiveTypes

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptResult(String fqn)
Scanners	filterResultsBy(Predicate<String> filter)
String	index() unique index name for scanner
List<Map.Entry<String,String>>	scan(javassist.bytecode.ClassFile classFile) scan the given classFile and produces list of Map.Entry key/values
static Scanners	valueOf(String name) Returns the enum constant of this type with the specified name.
static Scanners[]	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

Methods inherited from interface org.reflections.scanners.Scanner

acceptsInput, entries, entries, entries, entry, scan

Methods inherited from interface org.reflections.util.QueryBuilder

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

Methods inherited from interface org.reflections.util.NameHelper

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

Enum Constant Detail

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

Method Detail

values

public static Scanners[] 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 (Scanners c : Scanners.values())
    System.out.println(c);

Returns:

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

valueOf

public static Scanners valueOf(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:

IllegalArgumentException - if this enum type 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 Scanner

Specified by:

index in interface QueryBuilder

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

acceptResult

protected boolean acceptResult(String fqn)