Class ClassFilter.Builder

java.lang.Object

org.atteo.classindex.ClassFilter.CommonFilterBuilder

org.atteo.classindex.ClassFilter.Builder

All Implemented Interfaces:

ClassFilter.FilterBuilder, ClassFilter.Predicate, ClassFilter.UnionBuilder

Enclosing class:

ClassFilter

private static class ClassFilter.Builder
extends ClassFilter.CommonFilterBuilder
implements ClassFilter.UnionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ClassFilter.Predicate>	predicates

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
ClassFilter.Builder	annotatedWith(Class<? extends Annotation> annotation)	Returns classes annotated with given annotation.
ClassFilter.UnionBuilder	classes()	Returns only classes - filters out any interfaces.
ClassFilter.UnionBuilder	enclosedDirectlyIn(Class<?> enclosing)	Returns classes nested directly in given class.
ClassFilter.Builder	enclosedIn(Class<?> enclosing)	Returns classes nested (directly or indirectly) in given class.
ClassFilter.UnionBuilder	interfaces()	Returns only interfaces.
boolean	matches(Class<?> klass)	Returns true if the class should be included in the result.
ClassFilter.Builder	satisfying(ClassFilter.Predicate predicate)	Satisfies given predicate.
ClassFilter.Builder	topLevel()	Returns top level classes.
ClassFilter.UnionBuilder	topLevelOrStaticNested()	Returns top level or static nested classes.
ClassFilter.UnionBuilder	withModifiers(int modifiers)	Returns classes marked with given modifiers.
ClassFilter.UnionBuilder	withoutModifiers(int modifiers)	Returns classes not marked with given modifiers.
ClassFilter.UnionBuilder	withPublicDefaultConstructor()	Returns classes which have public default constructor.

Methods inherited from class ClassFilter.CommonFilterBuilder

from

Methods inherited from class Object

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

Methods inherited from interface ClassFilter.FilterBuilder

from

Field Details

predicates

private final List<ClassFilter.Predicate> predicates

Constructor Details

Builder

private Builder()

Method Details

satisfying

public ClassFilter.Builder satisfying(ClassFilter.Predicate predicate)

Description copied from interface: ClassFilter.UnionBuilder

Satisfies given predicate.

Specified by:

satisfying in interface ClassFilter.UnionBuilder

Parameters:

predicate - predicate to satisfy

topLevel

public ClassFilter.Builder topLevel()

Description copied from interface: ClassFilter.UnionBuilder

Returns top level classes.

Specified by:

topLevel in interface ClassFilter.UnionBuilder

topLevelOrStaticNested

public ClassFilter.UnionBuilder topLevelOrStaticNested()

Description copied from interface: ClassFilter.UnionBuilder

Returns top level or static nested classes.

Specified by:

topLevelOrStaticNested in interface ClassFilter.UnionBuilder

enclosedIn

public ClassFilter.Builder enclosedIn(Class<?> enclosing)

Description copied from interface: ClassFilter.UnionBuilder

Returns classes nested (directly or indirectly) in given class.

Specified by:

enclosedIn in interface ClassFilter.UnionBuilder

enclosedDirectlyIn

public ClassFilter.UnionBuilder enclosedDirectlyIn(Class<?> enclosing)

Description copied from interface: ClassFilter.UnionBuilder

Returns classes nested directly in given class.

Specified by:

enclosedDirectlyIn in interface ClassFilter.UnionBuilder

annotatedWith

public ClassFilter.Builder annotatedWith(Class<? extends Annotation> annotation)

Description copied from interface: ClassFilter.UnionBuilder

Returns classes annotated with given annotation.

As opposed to ClassIndex.getAnnotated(Class) this method only works if annotation is itself annotation with Retention set to RetentionPolicy.RUNTIME.

Specified by:

annotatedWith in interface ClassFilter.UnionBuilder

withModifiers

public ClassFilter.UnionBuilder withModifiers(int modifiers)

Description copied from interface: ClassFilter.UnionBuilder

Returns classes marked with given modifiers.

Specified by:

withModifiers in interface ClassFilter.UnionBuilder

Parameters:

modifiers - modifiers to expect, see Modifier

withoutModifiers

public ClassFilter.UnionBuilder withoutModifiers(int modifiers)

Description copied from interface: ClassFilter.UnionBuilder

Returns classes not marked with given modifiers.

Specified by:

withoutModifiers in interface ClassFilter.UnionBuilder

Parameters:

modifiers - modifiers to expect, see Modifier

withPublicDefaultConstructor

public ClassFilter.UnionBuilder withPublicDefaultConstructor()

Description copied from interface: ClassFilter.UnionBuilder

Returns classes which have public default constructor.

Default constructor is a constructor without any parameters. Note that (non-static) inner classes never have the default constructor (see: Inner classes and the myth of the default constructor)

Specified by:

withPublicDefaultConstructor in interface ClassFilter.UnionBuilder

interfaces

public ClassFilter.UnionBuilder interfaces()

Description copied from interface: ClassFilter.UnionBuilder

Returns only interfaces.

Specified by:

interfaces in interface ClassFilter.UnionBuilder

classes

public ClassFilter.UnionBuilder classes()

Description copied from interface: ClassFilter.UnionBuilder

Returns only classes - filters out any interfaces.

Specified by:

classes in interface ClassFilter.UnionBuilder

matches

public boolean matches(Class<?> klass)

Description copied from interface: ClassFilter.Predicate

Returns true if the class should be included in the result.

Specified by:

matches in interface ClassFilter.Predicate