Class ConfigurationBuilder

java.lang.Object

org.reflections.util.ConfigurationBuilder

All Implemented Interfaces:

Configuration

public class ConfigurationBuilder
extends Object
implements Configuration

Configuration builder for instantiating Reflections

// add urls for package prefix, use default scanners
new Reflections(
  new ConfigurationBuilder()
    .forPackage("org.reflections"))

new Reflections(
  new ConfigurationBuilder()
    .addUrls(ClasspathHelper.forPackage("org.reflections"))   // add urls for package prefix
    .addScanners(Scanners.values())                           // use all standard scanners
    .filterInputsBy(new FilterBuilder().includePackage(...))) // optionally filter inputs

defaults scanners: Scanners.SubTypes and Scanners.TypesAnnotated

(breaking changes) Inputs filter will NOT be set automatically, consider adding in case too many classes are scanned.

Field Summary

Fields

Modifier and Type	Field	Description
private ClassLoader[]	classLoaders
static final Predicate<String>	DEFAULT_INPUTS_FILTER
static final Set<Scanner>	DEFAULT_SCANNERS
private boolean	expandSuperTypes
private Predicate<String>	inputsFilter
private boolean	isParallel
private Set<Scanner>	scanners
private Set<URL>	urls

Constructor Summary

Constructors

Constructor	Description
ConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
ConfigurationBuilder	addClassLoaders(ClassLoader... classLoaders)	add optional class loaders used for resolving types.
ConfigurationBuilder	addScanners(Scanner... scanners)	set the scanners instances for scanning different metadata
ConfigurationBuilder	addUrls(URL... urls)	add urls to be scanned
ConfigurationBuilder	addUrls(Collection<URL> urls)	add urls to be scanned
static ConfigurationBuilder	build(Object... params)	constructs a ConfigurationBuilder.
ConfigurationBuilder	filterInputsBy(Predicate<String> inputsFilter)	sets the input filter for all resources to be scanned.
ConfigurationBuilder	forPackage(String pkg, ClassLoader... classLoaders)	addUrls(URL...) by applying ClasspathHelper.forPackage(String, ClassLoader...) for the given pkg
ConfigurationBuilder	forPackages(String... packages)	addUrls(URL...) by applying ClasspathHelper.forPackage(String, ClassLoader...) for the given packages
ClassLoader[]	getClassLoaders()	optional class loaders used for resolving types.
Predicate<String>	getInputsFilter()	the fully qualified name filter used to filter types to be scanned.
Set<Scanner>	getScanners()	the scanner instances used for indexing metadata.
Set<URL>	getUrls()	the urls to be scanned.
boolean	isParallel()	scan urls in parallel.
ConfigurationBuilder	setClassLoaders(ClassLoader[] classLoaders)	set optional class loaders used for resolving types.
ConfigurationBuilder	setExpandSuperTypes(boolean expandSuperTypes)	if set to true, Reflections will expand super types after scanning.
ConfigurationBuilder	setInputsFilter(Predicate<String> inputsFilter)	sets the input filter for all resources to be scanned.
ConfigurationBuilder	setParallel(boolean parallel)	if true, scan urls in parallel.
ConfigurationBuilder	setScanners(Scanner... scanners)	set the scanners instances for scanning different metadata
ConfigurationBuilder	setUrls(URL... urls)	set the urls to be scanned
ConfigurationBuilder	setUrls(Collection<URL> urls)	set the urls to be scanned
boolean	shouldExpandSuperTypes()	if true (default), expand super types after scanning, for super types that were not scanned.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_SCANNERS

public static final Set<Scanner> DEFAULT_SCANNERS

DEFAULT_INPUTS_FILTER

public static final Predicate<String> DEFAULT_INPUTS_FILTER

scanners

private Set<Scanner> scanners

urls

private Set<URL> urls

inputsFilter

private Predicate<String> inputsFilter

isParallel

private boolean isParallel

classLoaders

private ClassLoader[] classLoaders

expandSuperTypes

private boolean expandSuperTypes

Constructor Details

ConfigurationBuilder

public ConfigurationBuilder()

Method Details

build

public static ConfigurationBuilder build(Object... params)

constructs a ConfigurationBuilder.

each parameter in params is referred by its type:

• String - add urls using ClasspathHelper.forPackage(String, ClassLoader...) and an input filter
• Class - add urls using ClasspathHelper.forClass(Class, ClassLoader...) and an input filter
• Scanner - use scanner, overriding default scanners
• URL - add url for scanning
• Predicate - set/override inputs filter
• ClassLoader - use these classloaders in order to find urls using ClasspathHelper and for resolving types
• Object[] - flatten and use each element as above

input filter will be set according to given packages

prefer using the explicit accessor methods instead:

new ConfigurationBuilder().forPackage(...).setScanners(...)

forPackage

public ConfigurationBuilder forPackage(String pkg,
 ClassLoader... classLoaders)

addUrls(URL...) by applying ClasspathHelper.forPackage(String, ClassLoader...) for the given pkg

forPackages

public ConfigurationBuilder forPackages(String... packages)

addUrls(URL...) by applying ClasspathHelper.forPackage(String, ClassLoader...) for the given packages

getScanners

public Set<Scanner> getScanners()

Description copied from interface: Configuration

the scanner instances used for indexing metadata. defaults to SubTypes and TypesAnnotated.

Specified by:

getScanners in interface Configuration

setScanners

public ConfigurationBuilder setScanners(Scanner... scanners)

set the scanners instances for scanning different metadata

addScanners

public ConfigurationBuilder addScanners(Scanner... scanners)

set the scanners instances for scanning different metadata

getUrls

public Set<URL> getUrls()

Description copied from interface: Configuration

the urls to be scanned. required.

Specified by:

getUrls in interface Configuration

setUrls

public ConfigurationBuilder setUrls(Collection<URL> urls)

set the urls to be scanned

use ClasspathHelper convenient methods to get the relevant urls

see also forPackages(String...)

setUrls

public ConfigurationBuilder setUrls(URL... urls)

set the urls to be scanned

use ClasspathHelper convenient methods to get the relevant urls

see also forPackages(String...)

addUrls

public ConfigurationBuilder addUrls(Collection<URL> urls)

add urls to be scanned

use ClasspathHelper convenient methods to get the relevant urls

see also forPackages(String...)

addUrls

public ConfigurationBuilder addUrls(URL... urls)

add urls to be scanned

use ClasspathHelper convenient methods to get the relevant urls

see also forPackages(String...)

getInputsFilter

public Predicate<String> getInputsFilter()

Description copied from interface: Configuration

the fully qualified name filter used to filter types to be scanned. defaults to accept all inputs (if null).

Specified by:

getInputsFilter in interface Configuration

setInputsFilter

public ConfigurationBuilder setInputsFilter(Predicate<String> inputsFilter)

sets the input filter for all resources to be scanned.

prefer using FilterBuilder

filterInputsBy

public ConfigurationBuilder filterInputsBy(Predicate<String> inputsFilter)

sets the input filter for all resources to be scanned.

prefer using FilterBuilder

isParallel

public boolean isParallel()

Description copied from interface: Configuration

scan urls in parallel. defaults to true.

Specified by:

isParallel in interface Configuration

setParallel

public ConfigurationBuilder setParallel(boolean parallel)

if true, scan urls in parallel.

getClassLoaders

public ClassLoader[] getClassLoaders()

Description copied from interface: Configuration

optional class loaders used for resolving types.

Specified by:

getClassLoaders in interface Configuration

setClassLoaders

public ConfigurationBuilder setClassLoaders(ClassLoader[] classLoaders)

set optional class loaders used for resolving types.

addClassLoaders

public ConfigurationBuilder addClassLoaders(ClassLoader... classLoaders)

add optional class loaders used for resolving types.

shouldExpandSuperTypes

public boolean shouldExpandSuperTypes()

Description copied from interface: Configuration

if true (default), expand super types after scanning, for super types that were not scanned.

see Reflections.expandSuperTypes(Map, Map)

Specified by:

shouldExpandSuperTypes in interface Configuration

setExpandSuperTypes

public ConfigurationBuilder setExpandSuperTypes(boolean expandSuperTypes)

if set to true, Reflections will expand super types after scanning.

see Reflections.expandSuperTypes(Map, Map)