Module org.microbean.bean

Package org.microbean.bean

Class TypeMatcher

java.lang.Object

org.microbean.bean.TypeMatcher

All Implemented Interfaces:

Constable, BiPredicate<TypeMirror,TypeMirror>, Matcher<TypeMirror,TypeMirror>

public final class TypeMatcher
extends Object
implements Constable, Matcher<TypeMirror,TypeMirror>

A Matcher encapsulating CDI-compatible type matching rules.

Author:

Laird Nelson

See Also:

• test(TypeMirror, TypeMirror)

Constructor Summary

Constructors

Constructor	Description
TypeMatcher(TypeAndElementSource tes)	Creates a new TypeMatcher.

Method Summary

Modifier and Type	Method	Description
final Optional<? extends ConstantDesc>	describeConstable()	Returns an Optional housing a ConstantDesc that represents this TypeMatcher.
final boolean	test(TypeMirror receiver, TypeMirror payload)	Returns true if and only if the supplied payload argument matches the supplied receiver argument, according to the rules defined by section 2.4.2.1 of the CDI specification.
final TypeAndElementSource	typeAndElementSource()	Returns the TypeAndElementSource used by this TypeMatcher.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiPredicate

and, negate, or

Constructor Details

TypeMatcher

public TypeMatcher(TypeAndElementSource tes)

Creates a new TypeMatcher.

Parameters:

tes - a TypeAndElementSource; must not be null

Throws:

NullPointerException - if tes is null

See Also:

• TypeAndElementSource

Method Details

describeConstable

public final Optional<? extends ConstantDesc> describeConstable()

Returns an Optional housing a ConstantDesc that represents this TypeMatcher.

This method never returns null.

The default implementation of this method relies on the presence of a public constructor that accepts a single TypeAndElementSource-typed argument.

The Optional returned by an invocation of this method may be, and often will be, empty.

Specified by:

describeConstable in interface Constable

Returns:

an Optional housing a ConstantDesc that represents this TypeMatcher; never null

See Also:

• Constable.describeConstable()

test

public final boolean test(TypeMirror receiver,
 TypeMirror payload)

Returns true if and only if the supplied payload argument matches the supplied receiver argument, according to the rules defined by section 2.4.2.1 of the CDI specification.

Specified by:

test in interface BiPredicate<TypeMirror,TypeMirror>

Specified by:

test in interface Matcher<TypeMirror,TypeMirror>

Parameters:

receiver - the left hand side of a type assignment; must not be null

payload - the right hand side of a type assignment; must not be null

Returns:

true if and only if the supplied payload argument matches the supplied receiver argument, according to the rules defined by section 2.4.2.1 of the CDI specification; false otherwise

Throws:

NullPointerException - if either argument is null

IllegalArgumentException - if either type is any type other than an array type, a primitive type, or a declared type

typeAndElementSource

public final TypeAndElementSource typeAndElementSource()

Returns the TypeAndElementSource used by this TypeMatcher.

Returns:

the TypeAndElementSource used by this TypeMatcher; never null

See Also:

• TypeMatcher(TypeAndElementSource)
• TypeAndElementSource