Class InterceptorBindings

java.lang.Object

org.microbean.producer.InterceptorBindings

public class InterceptorBindings
extends Object

A utility class providing methods that work with interceptor bindings.

Author:

Laird Nelson

Constructor Summary

Constructors

Constructor	Description
InterceptorBindings(Domain domain)	Creates a new InterceptorBindings.
InterceptorBindings(Domain domain, AnnotationMirror metaInterceptorBinding, AnnotationMirror anyInterceptorBinding, Predicate<? super ExecutableElement> annotationElementInclusionPredicate)	Creates a new InterceptorBindings.

Method Summary

Modifier and Type	Method	Description
final AnnotationMirror	anyInterceptorBinding()	Returns a non-null, determinate AnnotationMirror representing the any interceptor binding.
final boolean	anyInterceptorBinding(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is the same as the any interceptor binding.
final List<AnnotationMirror>	anyInterceptorBindings()	Returns a non-null, determinate, immutable List housing only the any interceptor binding.
final boolean	interceptorBinding(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-interceptor binding.
List<AnnotationMirror>	interceptorBindings(Collection<? extends AnnotationMirror> as)	Returns a non-null, determinate, immutable List of AnnotationMirror instances drawn from the supplied Collection that are deemed to be interceptor bindings.
AnnotationMirror	metaInterceptorBinding()	Returns a non-null, determinate AnnotationMirror representing the (meta-) interceptor binding.
final boolean	metaInterceptorBinding(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-interceptor binding.
final List<AnnotationMirror>	metaInterceptorBindings()	Returns a non-null, determinate, immutable List whose sole element is the meta-interceptor binding annotation.

Methods inherited from class Object

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

Constructor Details

InterceptorBindings

public InterceptorBindings(Domain domain)

Creates a new InterceptorBindings.

Parameters:

domain - a Domain; must not be null

Throws:

NullPointerException - if domain is null

See Also:

• InterceptorBindings(Domain, AnnotationMirror, AnnotationMirror, Predicate)

InterceptorBindings

public InterceptorBindings(Domain domain,
 AnnotationMirror metaInterceptorBinding,
 AnnotationMirror anyInterceptorBinding,
 Predicate<? super ExecutableElement> annotationElementInclusionPredicate)

Creates a new InterceptorBindings.

Parameters:

domain - a Domain; must not be null

metaInterceptorBinding - an AnnotationMirror to serve as the meta-interceptor binding; may (commonly) be null in which case a synthetic meta-interceptor binding will be used instead

anyInterceptorBinding - an AnnotationMirror indicating that any interceptor binding should match; may be null

annotationElementInclusionPredicate - a Predicate that returns true if a given ExecutableElement, representing an annotation element, is to be included in any comparison operation; may be null in which case it is as if ()-> true were supplied instead

Throws:

NullPointerException - if domain is null

Method Details

anyInterceptorBinding

public final AnnotationMirror anyInterceptorBinding()

Returns a non-null, determinate AnnotationMirror representing the any interceptor binding.

Returns:

a non-null, determinate AnnotationMirror representing the any interceptor binding

anyInterceptorBinding

public final boolean anyInterceptorBinding(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror is the same as the any interceptor binding.

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror is the same as the any interceptor binding

Throws:

NullPointerException - if a is null

See Also:

• anyInterceptorBinding()
• AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, Predicate)

anyInterceptorBindings

public final List<AnnotationMirror> anyInterceptorBindings()

Returns a non-null, determinate, immutable List housing only the any interceptor binding.

Returns:

a non-null, determinate, immutable List housing only the any interceptor binding

metaInterceptorBinding

public AnnotationMirror metaInterceptorBinding()

Returns a non-null, determinate AnnotationMirror representing the (meta-) interceptor binding.

Returns:

a non-null, determinate AnnotationMirror representing the (meta-) interceptor binding

metaInterceptorBinding

public final boolean metaInterceptorBinding(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-interceptor binding.

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-interceptor binding

Throws:

NullPointerException - if a is null

metaInterceptorBindings

public final List<AnnotationMirror> metaInterceptorBindings()

Returns a non-null, determinate, immutable List whose sole element is the meta-interceptor binding annotation.

Returns:

a non-null, determinate, immutable List whose sole element is the meta-interceptor binding annotation

interceptorBinding

public final boolean interceptorBinding(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-interceptor binding.

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-interceptor binding

Throws:

NullPointerException - if a is null

interceptorBindings

public List<AnnotationMirror> interceptorBindings(Collection<? extends AnnotationMirror> as)

Returns a non-null, determinate, immutable List of AnnotationMirror instances drawn from the supplied Collection that are deemed to be interceptor bindings.

In this implementation, cycles are avoided and comparisons are accomplished with the AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, Predicate) method.

This implementation eliminates duplicates as calculated via the AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, Predicate) method.

This implementation considers interceptor bindings to be transitive. Consequently, the returned List may be greater in size than the supplied Collection.

Parameters:

as - a non-null, determinate Collection of AnnotationMirrors

Returns:

a non-null, determinate, immutable List of AnnotationMirror instances drawn from the supplied Collection that were deemed to be interceptor bindings

Throws:

NullPointerException - if as is null

See Also:

• interceptorBinding(AnnotationMirror)
• AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, Predicate)