Package org.reflections.util

Class FilterBuilder

java.lang.Object

org.reflections.util.FilterBuilder

All Implemented Interfaces:

Predicate<String>

public class FilterBuilder
extends Object
implements Predicate<String>

Builds include/exclude filters for Reflections.

For example:

 Predicate filter1 = FilterBuilder.parsePackages("-java, "-javax");
 Predicate filter2 = new FilterBuilder().include(".*").exclude("java.*");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterBuilder.Exclude
static class	FilterBuilder.Include
static class	FilterBuilder.Matcher

Constructor Summary

Constructors

Constructor	Description
FilterBuilder()

Method Summary

Modifier and Type	Method	Description
FilterBuilder	add(Predicate<String> filter)	add a Predicate to the chain of predicates
FilterBuilder	exclude(String regex)	exclude a regular expression
FilterBuilder	excludePackage(Class<?> aClass)	exclude a package of a given class
FilterBuilder	excludePackage(String prefix)	exclude a package of a given prefix
FilterBuilder	include(String regex)	include a regular expression
FilterBuilder	includePackage(Class<?> aClass)	include a package of a given class
FilterBuilder	includePackage(String... prefixes)	include packages of given prefixes
static FilterBuilder	parse(String includeExcludeString)	Parses a string representation of an include/exclude filter.
static FilterBuilder	parsePackages(String includeExcludeString)	Parses a string representation of an include/exclude filter.
static String	prefix(String qualifiedName)
boolean	test(String regex)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Constructor Detail

FilterBuilder

public FilterBuilder()

Method Detail

include

public FilterBuilder include(String regex)

include a regular expression

exclude

public FilterBuilder exclude(String regex)

exclude a regular expression

add

public FilterBuilder add(Predicate<String> filter)

add a Predicate to the chain of predicates

includePackage

public FilterBuilder includePackage(Class<?> aClass)

include a package of a given class

excludePackage

public FilterBuilder excludePackage(Class<?> aClass)

exclude a package of a given class

includePackage

public FilterBuilder includePackage(String... prefixes)

include packages of given prefixes

excludePackage

public FilterBuilder excludePackage(String prefix)

exclude a package of a given prefix

prefix

public static String prefix(String qualifiedName)

toString

public String toString()

Overrides:

toString in class Object

test

public boolean test(String regex)

Specified by:

test in interface Predicate<String>

parse

public static FilterBuilder parse(String includeExcludeString)

Parses a string representation of an include/exclude filter.

The given includeExcludeString is a comma separated list of regexes, each starting with either + or - to indicate include/exclude.

For example parsePackages("-java\\..*, -javax\\..*, -sun\\..*, -com\\.sun\\..*") or parse("+com\\.myn\\..*,-com\\.myn\\.excluded\\..*"). Note that "-java\\..*" will block "java.foo" but not "javax.foo".

See also the more useful parsePackages(String) method.

parsePackages

public static FilterBuilder parsePackages(String includeExcludeString)

Parses a string representation of an include/exclude filter.

The given includeExcludeString is a comma separated list of package name segments, each starting with either + or - to indicate include/exclude.

For example parsePackages("-java, -javax, -sun, -com.sun") or parse("+com.myn,-com.myn.excluded"). Note that "-java" will block "java.foo" but not "javax.foo".

The input strings "-java" and "-java." are equivalent.