org.reflections.util
Class FilterBuilder

java.lang.Object
  org.reflections.util.FilterBuilder

All Implemented Interfaces:

com.google.common.base.Predicate<String>

public class FilterBuilder
extends Object
implements com.google.common.base.Predicate<String>

an include exclude filter builder

for example:

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

Nested Class Summary

static class	FilterBuilder.Exclude
static class	FilterBuilder.Include
static class	FilterBuilder.Matcher

Constructor Summary

FilterBuilder()

Method Summary

FilterBuilder	add(com.google.common.base.Predicate<String> filter) add a Predicate to the chain of predicates
boolean	apply(String regex)
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 prefix) include a package of a given prefix
static FilterBuilder	parse(String includeExcludeString) parses a string representation of include exclude filter
static String	prefix(String qualifiedName)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Predicate

equals

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(com.google.common.base.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 prefix)

include a package of a given prefix

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

apply

public boolean apply(String regex)

Specified by:

apply in interface com.google.common.base.Predicate<String>

parse

public static FilterBuilder parse(String includeExcludeString)

parses a string representation of include exclude filter

the given includeExcludeString is a comma separated list of patterns, each starts with either + or - to indicate include/exclude resp. followed by the regular expression pattern

for example parse("-java., -javax., -sun., -com.sun.") or parse("+com.myn,-com.myn.excluded")