Interface ReferencesSelector

All Known Subinterfaces:

Creation<I>, Destruction, References<R>

public interface ReferencesSelector

A supplier of References objects.

Author:

Laird Nelson

See Also:

• references(Annotated)
• reference(Annotated)
• 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 non-null Domain that can be used to furnish AnnotatedConstructs.
default <R> R	reference(AnnotatedConstruct ac)	Deprecated. Please use the reference(Annotated) method instead.
default <R> R	reference(Annotated<? extends AnnotatedConstruct> aac)	A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference compatible with the supplied Annotated<? extends AnnotatedConstruct>.
<R> R	reference(Bean<R> bean)	Returns a non-null, determinate, contextual reference appropriate for the supplied Bean.
default <R> References<R>	references(AnnotatedConstruct ac)	Deprecated. Please use the references(Annotated) method instead.
<R> References<R>	references(Annotated<? extends AnnotatedConstruct> aac)	Returns a non-null, determinate References capable of locating contextual references compatible with the supplied Annotated<? extends AnnotatedConstruct>.

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 non-null Domain that can be used to furnish AnnotatedConstructs.

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

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(Annotated) method, since you need a Domain to make an Annotated<? extends AnnotatedConstruct>.

Returns:

a non-null Domain

See Also:

• Domain

reference

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

Returns a non-null, determinate, contextual reference 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, must ensure that ultimately the supplied Bean's affiliated Factory is the mechanism used, and no other is used, to create any contextual instance underlying the contextual reference to be returned.

Type Parameters:

R - the contextual reference type

Parameters:

bean - a non-null Bean

Returns:

a non-null, determinate, contextual reference appropriate for the supplied Bean

Throws:

NullPointerException - if bean is null

IllegalArgumentException - if bean is unsuitable in any way

references

<R> References<R> references(Annotated<? extends AnnotatedConstruct> aac)

Returns a non-null, determinate References capable of locating contextual references compatible with the supplied Annotated<? extends AnnotatedConstruct>.

Type Parameters:

R - the contextual reference type

Parameters:

aac - a non-null Annotated<? extends AnnotatedConstruct> describing the putative contextual reference; must represent <R>

Returns:

a non-null, determinate References

Throws:

NullPointerException - if aac is null

IllegalArgumentException - if aac is unsuitable in any way

See Also:

• References
• Annotated.of(AnnotatedConstruct)

references

@Deprecated
default <R> References<R> references(AnnotatedConstruct ac)

Deprecated.

Please use the references(Annotated) method instead.

Returns a non-null, determinate References capable of locating contextual references compatible with the supplied AnnotatedConstruct.

Type Parameters:

R - the contextual reference type

Parameters:

ac - a non-null AnnotatedConstruct describing the putative contextual reference; must represent <R>

Returns:

a non-null, determinate References

Throws:

NullPointerException - if ac is null

IllegalArgumentException - if ac is unsuitable in any way

See Also:

• References
• Annotated.of(AnnotatedConstruct)

reference

@Deprecated
default <R> R reference(AnnotatedConstruct ac)

Deprecated.

Please use the reference(Annotated) method instead.

A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference compatible with the supplied AnnotatedConstruct.

Type Parameters:

R - the contextual reference type

Parameters:

ac - a non-null AnnotatedConstruct describing the putative contextual reference; must represent <R>

Returns:

a non-null, determinate contextual reference

Throws:

NullPointerException - if ac is null

UnsatisfiedResolutionException - if there is no compatible contextual reference

AmbiguousResolutionException - if there is more than one compatible contextual reference

See Also:

• references(Annotated)
• Annotated.of(AnnotatedConstruct)
• References.get()

reference

default <R> R reference(Annotated<? extends AnnotatedConstruct> aac)

A convenience method that acquires and returns what is presumed, possibly incorrectly, to be the sole contextual reference compatible with the supplied Annotated<? extends AnnotatedConstruct>.

Type Parameters:

R - the contextual reference type

Parameters:

aac - a non-null Annotated<? extends AnnotatedConstruct> describing the putative contextual reference; must represent <R>

Returns:

a non-null, determinate contextual reference

Throws:

NullPointerException - if aac is null

UnsatisfiedResolutionException - if there is no compatible contextual reference

AmbiguousResolutionException - if there is more than one compatible contextual reference

See Also:

• references(Annotated)
• References.get()