|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.reflections.util.ConfigurationBuilder
public class ConfigurationBuilder
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.getUrlsForCurrentClasspath()) .setScanners(new SubTypesScanner(), new TypeAnnotationsScanner().filterResultsBy(myClassAnnotationsFilter)));
default constructor sets reasonable defaults, such as SingleThreadExecutor for scanning, accept all for inputsFilter
, scanners set to SubTypesScanner
, TypeAnnotationsScanner
,
using XmlSerializer
Constructor Summary | |
---|---|
ConfigurationBuilder()
|
Method Summary | |
---|---|
boolean |
acceptsInput(java.lang.String inputFqn)
the fully qualified name filter used to filter types to be scanned |
ConfigurationBuilder |
filterInputsBy(com.google.common.base.Predicate<java.lang.String> inputsFilter)
sets the input filter for all resources to be scanned |
com.google.common.base.Supplier<java.util.concurrent.ExecutorService> |
getExecutorServiceSupplier()
creates an executor service used to scan files |
MetadataAdapter |
getMetadataAdapter()
the metadata adapter used to fetch metadata from classes |
java.util.Set<Scanner> |
getScanners()
the scanner instances used for scanning different metadata |
Serializer |
getSerializer()
the default serializer to use when saving Reflection |
java.util.Set<java.net.URL> |
getUrls()
the urls to be scanned |
ConfigurationBuilder |
setExecutorServiceSupplier(com.google.common.base.Supplier<java.util.concurrent.ExecutorService> executorServiceSupplier)
sets the executor service used for scanning. |
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(java.util.Collection<java.net.URL> urls)
set the urls to be scanned |
ConfigurationBuilder |
setUrls(java.net.URL... urls)
set the urls to be scanned |
ConfigurationBuilder |
useParallelExecutor()
sets the executor service used for scanning to ThreadPoolExecutor with core size as java.lang.Runtime#getRuntime#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 |
Constructor Detail |
---|
public ConfigurationBuilder()
Method Detail |
---|
public java.util.Set<Scanner> getScanners()
Configuration
getScanners
in interface Configuration
public ConfigurationBuilder setScanners(Scanner... scanners)
public java.util.Set<java.net.URL> getUrls()
Configuration
getUrls
in interface Configuration
public ConfigurationBuilder setUrls(java.util.Collection<java.net.URL> urls)
use ClasspathHelper
convenient methods to get the relevant urls
public ConfigurationBuilder setUrls(java.net.URL... urls)
use ClasspathHelper
convenient methods to get the relevant urls
public MetadataAdapter getMetadataAdapter()
Configuration
getMetadataAdapter
in interface Configuration
public ConfigurationBuilder setMetadataAdapter(MetadataAdapter metadataAdapter)
public boolean acceptsInput(java.lang.String inputFqn)
Configuration
acceptsInput
in interface Configuration
public ConfigurationBuilder filterInputsBy(com.google.common.base.Predicate<java.lang.String> inputsFilter)
supply a Predicate
or use the FilterBuilder
public com.google.common.base.Supplier<java.util.concurrent.ExecutorService> getExecutorServiceSupplier()
Configuration
getExecutorServiceSupplier
in interface Configuration
public ConfigurationBuilder setExecutorServiceSupplier(com.google.common.base.Supplier<java.util.concurrent.ExecutorService> executorServiceSupplier)
default is ThreadPoolExecutor with a single core
public ConfigurationBuilder useParallelExecutor()
java.lang.Runtime#getRuntime#availableProcessors()
default is ThreadPoolExecutor with a single core
public ConfigurationBuilder useParallelExecutor(int availableProcessors)
default is ThreadPoolExecutor with a single core
public Serializer getSerializer()
Configuration
getSerializer
in interface Configuration
public ConfigurationBuilder setSerializer(Serializer serializer)
Reflections.save(java.lang.String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |