Interface ReferencesSelector

All Known Subinterfaces:

Creation<I>, Destruction, References<R>

public interface ReferencesSelector

A supplier of References objects.

Author:

Laird Nelson

See Also:

• references(AttributedType)
• reference(AttributedType)
• References

Method Summary

Modifier and Type	Method	Description
boolean	destroy(Object r)	Destroys the supplied contextual reference if and only if it meets the conditions for destruction.
Domain	domain()	Returns a Domain that can be used to produce TypeMirrors so that AttributedType instances used by the references(AttributedType) and reference(AttributedType) methods may be created.
default <R> R	reference(AttributedType t)	A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference of the relevant type.
<R> R	reference(Bean<R> bean)	Returns a contextual reference of the relevant type appropriate for the supplied Bean.
<R> References<R>	references(AttributedType t)	Returns a References capable of locating contextual references of the relevant type.

Method Details

destroy

boolean destroy(Object r)

Destroys the supplied contextual reference if and only if it meets the conditions for destruction.

Parameters:

r - a contextual reference; may be null in which case false will be returned

Returns:

true if and only if destruction occurred

Throws:

DestructionException - if an error occurs

domain

Domain domain()

Returns a Domain that can be used to produce TypeMirrors so that AttributedType instances used by the references(AttributedType) and reference(AttributedType) methods may be created.

Implementations of this method must not return null.

Implementations of this method must be safe for concurrent use by multiple threads.

Implementations of this method must return a determinate value.

Design Note

Without this method, componenents using a ReferencesSelector will have to arrange to have their own Domain somehow. Inconveniently, this is the only type in the system that cannot be acquired by an invocation of the references(AttributedType) method, since you need a Domain to make an AttributedType.

Returns:

a non-null Domain

reference

<R> R reference(Bean<R> bean)

Returns a contextual reference of the relevant type appropriate for the supplied Bean.

Implementations of this method must be safe for concurrent use by multiple threads.

Implementations of this method must, directly or indirectly, use the supplied Bean's affiliated Factory to create any contextual instance underlying the contextual reference to be returned.

Type Parameters:

R - the contextual reference type

Parameters:

bean - a Bean; must not be null

Returns:

a non-null contextual reference

Throws:

NullPointerException - if bean is null

IllegalArgumentException - if bean is unsuitable in any way

references

<R> References<R> references(AttributedType t)

Returns a References capable of locating contextual references of the relevant type.

Type Parameters:

R - the contextual reference type

Parameters:

t - an AttributedType describing the contextual reference type; must not be null

Returns:

a non-null References

Throws:

NullPointerException - if t is null

IllegalArgumentException - if t is unsuitable in any way

See Also:

• References

reference

default <R> R reference(AttributedType t)

A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference of the relevant type.

Type Parameters:

R - the contextual reference type

Parameters:

t - an AttributedType describing the contextual reference type; must not be null

Returns:

a non-null contextual reference

Throws:

NullPointerException - if t is null

UnsatisfiedResolutionException - if there is no contextual reference for the relevant type

AmbiguousResolutionException - if there is more than one contextual reference for the relevant type

See Also:

• references(AttributedType)
• References.get()