ConfigurationBuilder (Reflections 0.9.11 API)

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

All Implemented Interfaces:: Configuration

public class ConfigurationBuilder
extends Object
implements Configuration

a fluent builder for Configuration, to be used for constructing a Reflections instance

usage:

      new Reflections(
          new ConfigurationBuilder()
              .filterInputsBy(new FilterBuilder().include("your project's common package prefix here..."))
              .setUrls(ClasspathHelper.forClassLoader())
              .setScanners(new SubTypesScanner(), new TypeAnnotationsScanner().filterResultsBy(myClassAnnotationsFilter)));

executorService is used optionally used for parallel scanning. if value is null then scanning is done in a simple for loop

defaults: accept all for inputsFilter, executorService is null, serializer is XmlSerializer

Field Summary

Fields
Modifier and Type Field and Description

protected MetadataAdapter metadataAdapter

Fields
Modifier and Type	Field and Description
`protected MetadataAdapter`	`metadataAdapter`

Constructor Summary

Constructors
Constructor and Description

ConfigurationBuilder()

Constructors
Constructor and Description
`ConfigurationBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfigurationBuilder`	`addClassLoader(ClassLoader classLoader)` add class loader, might be used for resolving methods/fields
`ConfigurationBuilder`	`addClassLoaders(ClassLoader... classLoaders)` add class loader, might be used for resolving methods/fields
`ConfigurationBuilder`	`addClassLoaders(Collection<ClassLoader> classLoaders)` add class loader, might be used for resolving methods/fields
`ConfigurationBuilder`	`addScanners(Scanner... scanners)` set the scanners instances for scanning different metadata
`ConfigurationBuilder`	`addUrls(Collection<URL> urls)` add urls to be scanned
`ConfigurationBuilder`	`addUrls(URL... urls)` add urls to be scanned
`static ConfigurationBuilder`	`build(Object... params)` constructs a `ConfigurationBuilder` using the given parameters, in a non statically typed way.
`ConfigurationBuilder`	`filterInputsBy(com.google.common.base.Predicate<String> inputsFilter)` sets the input filter for all resources to be scanned.
`ConfigurationBuilder`	`forPackages(String... packages)`
`ClassLoader[]`	`getClassLoaders()` get class loader, might be used for scanning or resolving methods/fields
`ExecutorService`	`getExecutorService()` executor service used to scan files.
`com.google.common.base.Predicate<String>`	`getInputsFilter()` get the fully qualified name filter used to filter types to be scanned
`MetadataAdapter`	`getMetadataAdapter()` returns the metadata adapter.
`Set<Scanner>`	`getScanners()` the scanner instances used for scanning different metadata
`Serializer`	`getSerializer()` the default serializer to use when saving Reflection
`Set<URL>`	`getUrls()` the urls to be scanned
`void`	`setClassLoaders(ClassLoader[] classLoaders)` set class loader, might be used for resolving methods/fields
`ConfigurationBuilder`	`setExecutorService(ExecutorService executorService)` sets the executor service used for scanning.
`ConfigurationBuilder`	`setExpandSuperTypes(boolean expandSuperTypes)` if set to true, Reflections will expand super types after scanning.
`void`	`setInputsFilter(com.google.common.base.Predicate<String> inputsFilter)` sets the input filter for all resources to be scanned.
`ConfigurationBuilder`	`setMetadataAdapter(MetadataAdapter metadataAdapter)` sets the metadata adapter used to fetch metadata from classes
`ConfigurationBuilder`	`setScanners(Scanner... scanners)` set the scanners instances for scanning different metadata
`ConfigurationBuilder`	`setSerializer(Serializer serializer)` sets the serializer used when issuing `Reflections.save(java.lang.String)`
`ConfigurationBuilder`	`setUrls(Collection<URL> urls)` set the urls to be scanned
`ConfigurationBuilder`	`setUrls(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.
`ConfigurationBuilder`	`useParallelExecutor()` sets the executor service used for scanning to ThreadPoolExecutor with core size as `Runtime.availableProcessors()`
`ConfigurationBuilder`	`useParallelExecutor(int availableProcessors)` sets the executor service used for scanning to ThreadPoolExecutor with core size as the given availableProcessors parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - metadataAdapter
```
protected MetadataAdapter metadataAdapter
```
- Constructor Detail
  - ConfigurationBuilder
```
public ConfigurationBuilder()
```
- Method Detail
  - build
```
public static ConfigurationBuilder build(@Nullable
                                         Object... params)
```
    constructs a ConfigurationBuilder using the given parameters, in a non statically typed way. that is, each element in params is guessed by it's type and populated into the configuration.
    - String - add urls using ClasspathHelper.forPackage(String, ClassLoader...) ()}
    - Class - add urls using ClasspathHelper.forClass(Class, ClassLoader...)
    - ClassLoader - use these classloaders in order to find urls in ClasspathHelper.forPackage(), ClasspathHelper.forClass() and for resolving types
    - Scanner - use given scanner, overriding the default scanners
    - URL - add the given url for scanning
    - Object[] - flatten and use each element as above
    an input FilterBuilder will be set according to given packages.
    use any parameter type in any order. this constructor uses instanceof on each param and instantiate a ConfigurationBuilder appropriately.
  - forPackages
```
public ConfigurationBuilder forPackages(String... packages)
```
  - getScanners
```
@Nonnull
public Set<Scanner> getScanners()
```
    Description copied from interface: Configuration
    
    the scanner instances used for scanning different metadata
    
    Specified by:
    
    getScanners in interface Configuration
  - setScanners
```
public ConfigurationBuilder setScanners(@Nonnull
                                        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
```
@Nonnull
public Set<URL> getUrls()
```
    Description copied from interface: Configuration
    
    the urls to be scanned
    
    Specified by:
    
    getUrls in interface Configuration
  - setUrls
```
public ConfigurationBuilder setUrls(@Nonnull
                                    Collection<URL> urls)
```
    set the urls to be scanned
    use ClasspathHelper convenient methods to get the relevant urls
  - setUrls
```
public ConfigurationBuilder setUrls(URL... urls)
```
    set the urls to be scanned
    use ClasspathHelper convenient methods to get the relevant urls
  - addUrls
```
public ConfigurationBuilder addUrls(Collection<URL> urls)
```
    add urls to be scanned
    use ClasspathHelper convenient methods to get the relevant urls
  - addUrls
```
public ConfigurationBuilder addUrls(URL... urls)
```
    add urls to be scanned
    use ClasspathHelper convenient methods to get the relevant urls
  - getMetadataAdapter
```
public MetadataAdapter getMetadataAdapter()
```
    returns the metadata adapter. if javassist library exists in the classpath, this method returns JavassistAdapter otherwise defaults to JavaReflectionAdapter.
    the JavassistAdapter is preferred in terms of performance and class loading.
    
    Specified by:
    
    getMetadataAdapter in interface Configuration
  - setMetadataAdapter
```
public ConfigurationBuilder setMetadataAdapter(MetadataAdapter metadataAdapter)
```
    sets the metadata adapter used to fetch metadata from classes
  - getInputsFilter
```
@Nullable
public com.google.common.base.Predicate<String> getInputsFilter()
```
    Description copied from interface: Configuration
    
    get the fully qualified name filter used to filter types to be scanned
    
    Specified by:
    
    getInputsFilter in interface Configuration
  - setInputsFilter
```
public void setInputsFilter(@Nullable
                            com.google.common.base.Predicate<String> inputsFilter)
```
    sets the input filter for all resources to be scanned.
    supply a Predicate or use the FilterBuilder
  - filterInputsBy
```
public ConfigurationBuilder filterInputsBy(com.google.common.base.Predicate<String> inputsFilter)
```
    sets the input filter for all resources to be scanned.
    supply a Predicate or use the FilterBuilder
  - getExecutorService
```
@Nullable
public ExecutorService getExecutorService()
```
    Description copied from interface: Configuration
    
    executor service used to scan files. if null, scanning is done in a simple for loop
    
    Specified by:
    
    getExecutorService in interface Configuration
  - setExecutorService
```
public ConfigurationBuilder setExecutorService(@Nullable
                                               ExecutorService executorService)
```
    sets the executor service used for scanning.
  - useParallelExecutor
```
public ConfigurationBuilder useParallelExecutor()
```
    sets the executor service used for scanning to ThreadPoolExecutor with core size as Runtime.availableProcessors()
    default is ThreadPoolExecutor with a single core
  - useParallelExecutor
```
public ConfigurationBuilder useParallelExecutor(int availableProcessors)
```
    sets the executor service used for scanning to ThreadPoolExecutor with core size as the given availableProcessors parameter. the executor service spawns daemon threads by default.
    default is ThreadPoolExecutor with a single core
  - getSerializer
```
public Serializer getSerializer()
```
    Description copied from interface: Configuration
    
    the default serializer to use when saving Reflection
    
    Specified by:
    
    getSerializer in interface Configuration
  - setSerializer
```
public ConfigurationBuilder setSerializer(Serializer serializer)
```
    sets the serializer used when issuing Reflections.save(java.lang.String)
  - getClassLoaders
```
@Nullable
public ClassLoader[] getClassLoaders()
```
    get class loader, might be used for scanning or resolving methods/fields
    
    Specified by:
    
    getClassLoaders in interface Configuration
  - 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()
    
    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()
  - setClassLoaders
```
public void setClassLoaders(@Nullable
                            ClassLoader[] classLoaders)
```
    set class loader, might be used for resolving methods/fields
  - addClassLoader
```
public ConfigurationBuilder addClassLoader(ClassLoader classLoader)
```
    add class loader, might be used for resolving methods/fields
  - addClassLoaders
```
public ConfigurationBuilder addClassLoaders(ClassLoader... classLoaders)
```
    add class loader, might be used for resolving methods/fields
  - addClassLoaders
```
public ConfigurationBuilder addClassLoaders(Collection<ClassLoader> classLoaders)
```
    add class loader, might be used for resolving methods/fields

Class ConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metadataAdapter

Constructor Detail

ConfigurationBuilder

Method Detail

build

forPackages

getScanners

setScanners

addScanners

getUrls

setUrls

setUrls

addUrls

addUrls

getMetadataAdapter

setMetadataAdapter

getInputsFilter

setInputsFilter

filterInputsBy

getExecutorService

setExecutorService

useParallelExecutor

useParallelExecutor

getSerializer

setSerializer

getClassLoaders

shouldExpandSuperTypes

setExpandSuperTypes

setClassLoaders

addClassLoader

addClassLoaders

addClassLoaders