Class Beans

java.lang.Object

org.microbean.bean.Beans

public final class Beans
extends Object

Utility methods for working with Beans.

Author:

Laird Nelson

See Also:

• normalize(Collection)
• Bean

Constructor Summary

Constructors

Constructor	Description
Beans(AnnotationMirror alternate, AnnotationMirror rank)	Creates a new Beans.
Beans(Domain d)	Creates a new Beans.
Beans(Domain d, AnnotationMirror alternate, AnnotationMirror rank)	Creates a new Beans.

Method Summary

Modifier and Type	Method	Description
final boolean	alternate(Collection<? extends AnnotationMirror> as)	Returns true if and only if the supplied Collection of AnnotationMirrors contains at least one AnnotationMirror for which alternate(AnnotationMirror) returns true.
final boolean	alternate(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror designates whatever it annotates as being an alternate.
final boolean	alternate(Bean<?> b)	Returns true if and only if the supplied Bean has an Id for which alternate(Id) returns true.
final boolean	alternate(Id id)	Returns true if and only if the supplied Id has annotations for which alternate(Collection) returns true.
final List<Bean<?>>	normalize(Collection<? extends Bean<?>> beans)	Returns a non-null, determinate, immutable List containing a subset of distinct elements contained in the supplied Collection, sorted in a deliberately unspecified fashion.
final int	rank(Collection<? extends AnnotationMirror> as)	Iterates over the supplied Collection of AnnotationMirrors and invokes the rank(AnnotationMirror) method on each one until a non-zero result is found and returns that result, or 0 in all other cases.
final int	rank(AnnotationMirror a)	Returns an int representing the rank derivable from the supplied AnnotationMirror, which may be 0, or 0 if the supplied AnnotationMirror does not or cannot supply a rank.
final int	rank(Bean<?> b)	Returns the result of invoking the rank(Id) method with the supplied Bean's Id.
final int	rank(Id id)	Returns the result of invoking the rank(Collection) method with the supplied Id's annotations.
final Selectable<Annotated<? extends AnnotatedConstruct>, Bean<?>>	typesafeFilteringSelectable(Collection<? extends Bean<?>> beanCollection, Matcher<? super Annotated<? extends AnnotatedConstruct>, ? super Id> m)	Normalizes the supplied Collection of Beans and returns a Selectable suitable for it and the supplied Matcher, using the Selectables.filtering(Collection, BiPredicate) method internally.

Methods inherited from class Object

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

Constructor Details

Beans

public Beans(Domain d)

Creates a new Beans.

Parameters:

d - a non-null Domain

See Also:

• Beans(Domain, AnnotationMirror, AnnotationMirror)

Beans

public Beans(AnnotationMirror alternate,
 AnnotationMirror rank)

Creates a new Beans.

Parameters:

alternate - a non-null AnnotationMirror that will designate a Bean as being an alternate

rank - a non-null AnnotationMirror that can be examined to determine the rank of a Bean that has been deemed to be an alternate

Throws:

NullPointerException - if any argument is null

See Also:

• Beans(Domain, AnnotationMirror, AnnotationMirror)

Beans

public Beans(Domain d,
 AnnotationMirror alternate,
 AnnotationMirror rank)

Creates a new Beans.

Parameters:

d - a non-null Domain

alternate - an AnnotationMirror that will designate a Bean as being an alternate; may be null; if non-null must have a boolean-typed value element

rank - an AnnotationMirror that can be examined to determine the rank of a Bean that has been deemed to be an alternate; may be null; if non-null must have an int-typed value element

Method Details

normalize

public final List<Bean<?>> normalize(Collection<? extends Bean<?>> beans)

Returns a non-null, determinate, immutable List containing a subset of distinct elements contained in the supplied Collection, sorted in a deliberately unspecified fashion.

Parameters:

beans - a Collection of Beans; must not be null

Returns:

a non-null, determinate, immutable List

Throws:

NullPointerException - if beans is null

See Also:

• Bean.equals(Object)

typesafeFilteringSelectable

public final Selectable<Annotated<? extends AnnotatedConstruct>, Bean<?>> typesafeFilteringSelectable(Collection<? extends Bean<?>> beanCollection,
 Matcher<? super Annotated<? extends AnnotatedConstruct>, ? super Id> m)

Normalizes the supplied Collection of Beans and returns a Selectable suitable for it and the supplied Matcher, using the Selectables.filtering(Collection, BiPredicate) method internally.

The returned Selectable does not cache its results or resolve ambiguities.

Parameters:

beanCollection - a Collection of Beans; must not be null

m - a Matcher; must not be null

Returns:

a non-null, determinate Selectable

Throws:

NullPointerException - if any argument is null

See Also:

• Matcher.test(Object, Object)
• Selectables.filtering(Collection, java.util.function.BiPredicate)
• Selectables.ambiguityReducing(Selectable, Predicate, ToIntFunction)
• normalize(Collection)

alternate

public final boolean alternate(Bean<?> b)

Returns true if and only if the supplied Bean has an Id for which alternate(Id) returns true.

Parameters:

b - a non-null Bean

Returns:

true if and only if the supplied Bean has an Id for which alternate(Id) returns true

Throws:

NullPointerException - if b is null

See Also:

• alternate(Id)

alternate

public final boolean alternate(Id id)

Returns true if and only if the supplied Id has annotations for which alternate(Collection) returns true.

Parameters:

id - a non-null Id

Returns:

true if and only if the supplied Id has annotations for which alternate(Collection) returns true

Throws:

NullPointerException - if id is null

See Also:

• alternate(Collection)

alternate

public final boolean alternate(Collection<? extends AnnotationMirror> as)

Returns true if and only if the supplied Collection of AnnotationMirrors contains at least one AnnotationMirror for which alternate(AnnotationMirror) returns true.

Parameters:

as - a non-null Collection of AnnotationMirrors

Returns:

true if and only if the supplied Collection of AnnotationMirrors contains at least one AnnotationMirror for which alternate(AnnotationMirror) returns true

Throws:

NullPointerException - if as is null

See Also:

• alternate(AnnotationMirror)

alternate

public final boolean alternate(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror designates whatever it annotates as being an alternate.

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror designates whatever it annotates as being an alternate

Throws:

NullPointerException - if a is null

See Also:

• Beans(Domain, AnnotationMirror, AnnotationMirror)

rank

public final int rank(Bean<?> b)

Returns the result of invoking the rank(Id) method with the supplied Bean's Id.

Parameters:

b - a non-null Bean

Returns:

a rank, which may be 0

Throws:

NullPointerException - if b is null

See Also:

• rank(Id)

rank

public final int rank(Id id)

Returns the result of invoking the rank(Collection) method with the supplied Id's annotations.

Parameters:

id - a non-null Id

Returns:

a rank, which may be 0

Throws:

NullPointerException - if id is null

See Also:

• rank(Collection)

rank

public final int rank(Collection<? extends AnnotationMirror> as)

Iterates over the supplied Collection of AnnotationMirrors and invokes the rank(AnnotationMirror) method on each one until a non-zero result is found and returns that result, or 0 in all other cases.

Parameters:

as - a non-null Collection of AnnotationMirrors

Returns:

a rank, which may be 0

Throws:

NullPointerException - if as is null

See Also:

• rank(AnnotationMirror)

rank

public final int rank(AnnotationMirror a)

Returns an int representing the rank derivable from the supplied AnnotationMirror, which may be 0, or 0 if the supplied AnnotationMirror does not or cannot supply a rank.

Parameters:

a - a non-null AnnotationMirror

Returns:

an int representing the rank derivable from the supplied AnnotationMirror, which may be 0, or 0 if the supplied AnnotationMirror does not or cannot supply a rank

Throws:

NullPointerException - if a is null

See Also:

• Beans(Domain, AnnotationMirror, AnnotationMirror)