java.lang.Object
- org.reflections.util.ConfigurationBuilder

All Implemented Interfaces:: Configuration

public class ConfigurationBuilder
extends java.lang.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 java.lang.ClassLoader[]`	`classLoaders`
`static java.util.function.Predicate<java.lang.String>`	`DEFAULT_INPUTS_FILTER`
`static java.util.Set<Scanner>`	`DEFAULT_SCANNERS`
`private boolean`	`expandSuperTypes`
`private java.util.function.Predicate<java.lang.String>`	`inputsFilter`
`private boolean`	`isParallel`
`private java.util.Set<Scanner>`	`scanners`
`private java.util.Set<java.net.URL>`	`urls`

Constructor Summary

Constructors
Constructor Description

ConfigurationBuilder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConfigurationBuilder`	`addClassLoaders(java.lang.ClassLoader... classLoaders)`	add optional class loaders used for resolving types.
`ConfigurationBuilder`	`addScanners(Scanner... scanners)`	set the scanners instances for scanning different metadata
`ConfigurationBuilder`	`addUrls(java.net.URL... urls)`	add urls to be scanned
`ConfigurationBuilder`	`addUrls(java.util.Collection<java.net.URL> urls)`	add urls to be scanned
`static ConfigurationBuilder`	`build(java.lang.Object... params)`	constructs a `ConfigurationBuilder`.
`ConfigurationBuilder`	`filterInputsBy(java.util.function.Predicate<java.lang.String> inputsFilter)`	sets the input filter for all resources to be scanned.
`ConfigurationBuilder`	`forPackage(java.lang.String pkg, java.lang.ClassLoader... classLoaders)`	`addUrls(URL...)` by applying `ClasspathHelper.forPackage(String, ClassLoader...)` for the given `pkg`
`ConfigurationBuilder`	`forPackages(java.lang.String... packages)`	`addUrls(URL...)` by applying `ClasspathHelper.forPackage(String, ClassLoader...)` for the given `packages`
`java.lang.ClassLoader[]`	`getClassLoaders()`	optional class loaders used for resolving types.
`java.util.function.Predicate<java.lang.String>`	`getInputsFilter()`	the fully qualified name filter used to filter types to be scanned.
`java.util.Set<Scanner>`	`getScanners()`	the scanner instances used for indexing metadata.
`java.util.Set<java.net.URL>`	`getUrls()`	the urls to be scanned.
`boolean`	`isParallel()`	scan urls in parallel.
`ConfigurationBuilder`	`setClassLoaders(java.lang.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(java.util.function.Predicate<java.lang.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(java.net.URL... urls)`	set the urls to be scanned
`ConfigurationBuilder`	`setUrls(java.util.Collection<java.net.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SCANNERS
```
public static final java.util.Set<Scanner> DEFAULT_SCANNERS
```
  - DEFAULT_INPUTS_FILTER
```
public static final java.util.function.Predicate<java.lang.String> DEFAULT_INPUTS_FILTER
```
  - scanners
```
private java.util.Set<Scanner> scanners
```
  - urls
```
private java.util.Set<java.net.URL> urls
```
  - inputsFilter
```
private java.util.function.Predicate<java.lang.String> inputsFilter
```
  - isParallel
```
private boolean isParallel
```
  - classLoaders
```
private java.lang.ClassLoader[] classLoaders
```
  - expandSuperTypes
```
private boolean expandSuperTypes
```
- Constructor Detail
  - ConfigurationBuilder
```
public ConfigurationBuilder()
```
- Method Detail
  - build
```
public static ConfigurationBuilder build(java.lang.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(java.lang.String pkg,
                                       java.lang.ClassLoader... classLoaders)
```
    addUrls(URL...) by applying ClasspathHelper.forPackage(String, ClassLoader...) for the given pkg
  - forPackages
```
public ConfigurationBuilder forPackages(java.lang.String... packages)
```
    addUrls(URL...) by applying ClasspathHelper.forPackage(String, ClassLoader...) for the given packages
  - getScanners
```
public java.util.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 java.util.Set<java.net.URL> getUrls()
```
    Description copied from interface: Configuration
    
    the urls to be scanned. required.
    
    Specified by:
    
    getUrls in interface Configuration
  - setUrls
```
public ConfigurationBuilder setUrls(java.util.Collection<java.net.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(java.net.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(java.util.Collection<java.net.URL> urls)
```
    add urls to be scanned
    use ClasspathHelper convenient methods to get the relevant urls
    see also forPackages(String...)
  - addUrls
```
public ConfigurationBuilder addUrls(java.net.URL... urls)
```
    add urls to be scanned
    use ClasspathHelper convenient methods to get the relevant urls
    see also forPackages(String...)
  - getInputsFilter
```
public java.util.function.Predicate<java.lang.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(java.util.function.Predicate<java.lang.String> inputsFilter)
```
    sets the input filter for all resources to be scanned.
    prefer using FilterBuilder
  - filterInputsBy
```
public ConfigurationBuilder filterInputsBy(java.util.function.Predicate<java.lang.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 java.lang.ClassLoader[] getClassLoaders()
```
    Description copied from interface: Configuration
    
    optional class loaders used for resolving types.
    
    Specified by:
    
    getClassLoaders in interface Configuration
  - setClassLoaders
```
public ConfigurationBuilder setClassLoaders(java.lang.ClassLoader[] classLoaders)
```
    set optional class loaders used for resolving types.
  - addClassLoaders
```
public ConfigurationBuilder addClassLoaders(java.lang.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)

Class ConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SCANNERS

DEFAULT_INPUTS_FILTER

scanners

urls

inputsFilter

isParallel

classLoaders

expandSuperTypes

Constructor Detail

ConfigurationBuilder

Method Detail

build

forPackage

forPackages

getScanners

setScanners

addScanners

getUrls

setUrls

setUrls

addUrls

addUrls

getInputsFilter

setInputsFilter

filterInputsBy

isParallel

setParallel

getClassLoaders

setClassLoaders

addClassLoaders

shouldExpandSuperTypes

setExpandSuperTypes