Class Request<I,R>

java.lang.Object

org.microbean.reference.Request<I,R>

Type Parameters:

I - the contextual instance type being instantiated (see for example Creation)

R - the contextual reference type being sought (see References)

All Implemented Interfaces:

AutoCloseable, Iterable<R>, Creation<I>, Destruction, References<R>, ReferencesSelector, DestructorRegistry

public final class Request<I,R>
extends Object
implements Creation<I>, Destruction, DestructorRegistry, References<R>

A central object representing a request for dependencies that is a Creation (and therefore also a Destruction), a DestructorRegistry, and a References.

Instances of this class are the heart and soul of a dependency injection and acquisition system.

Author:

Laird Nelson

See Also:

• Creation
• Destruction
• DestructorRegistry
• References
• Factory.create(Creation)
• Factory.destroy(Object, Destruction)

Nested Class Summary

Nested classes/interfaces inherited from interface org.microbean.reference.DestructorRegistry

DestructorRegistry.Destructor

Constructor Summary

Constructors

Constructor	Description
Request(Domain d, org.microbean.assign.Selectable<? super org.microbean.assign.AttributedType, Bean<?>> s, Instances instances, ClientProxier cp)	Creates a new Request.
Request(Domain d, org.microbean.assign.Selectable<? super org.microbean.assign.AttributedType, Bean<?>> s, Instances instances, DestructorTree destructorTree, ClientProxier cp)	Creates a new Request.

Method Summary

Modifier and Type	Method	Description
final void	close()
final boolean	destroy(Object r)
final Domain	domain()
final Id	id()
final Iterator<R>	iterator()
final <R> R	reference(Bean<R> bean)
final <X> References<X>	references(org.microbean.assign.AttributedType rType)
final boolean	register(Object reference, DestructorRegistry.Destructor destructor)	Registers the supplied contextual instance such that at some future moment, or perhaps not at all, the supplied DestructorRegistry.Destructor will be run to destroy it idempotently, and returns true if and only if the registration was successful.
final int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.microbean.bean.Creation

creating

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.microbean.bean.References

get

Methods inherited from interface org.microbean.bean.ReferencesSelector

reference

Constructor Details

Request

public Request(Domain d,
 org.microbean.assign.Selectable<? super org.microbean.assign.AttributedType, Bean<?>> s,
 Instances instances,
 ClientProxier cp)

Creates a new Request.

Parameters:

d - a Domain; must not be null

s - a Selectable providing access to Beans by AttributedType; must not be null; must be safe for concurrent use by multiple threads; often assembled out of methods present in the Selectables and Beans classes, among other such utility classes

instances - an Instances responsible for using a Bean to acquire an appropriate Supplier of contextual instances; must not be null

cp - a ClientProxier; must not be null

Throws:

NullPointerException - if any argument is null

See Also:

• Request(Domain, Selectable, Instances, DestructorTree, ClientProxier)

Request

public Request(Domain d,
 org.microbean.assign.Selectable<? super org.microbean.assign.AttributedType, Bean<?>> s,
 Instances instances,
 DestructorTree destructorTree,
 ClientProxier cp)

Creates a new Request.

Parameters:

d - a Domain; must not be null

s - a Selectable providing access to Beans by AttributedType; must not be null; must be safe for concurrent use by multiple threads; often assembled out of methods present in the Selectables and Beans classes, among other such utility classes

instances - an Instances responsible for using a Bean to acquire an appropriate Supplier of contextual instances; must not be null

destructorTree - a DestructorTree; may be null in which case a default implementation will be used instead

cp - a ClientProxier; must not be null

Throws:

NullPointerException - if s, instances, or cp is null

Method Details

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Destruction

destroy

public final boolean destroy(Object r)

Specified by:

destroy in interface ReferencesSelector

domain

public final Domain domain()

Specified by:

domain in interface ReferencesSelector

id

public final Id id()

Specified by:

id in interface Creation<I>

iterator

public final Iterator<R> iterator()

Specified by:

iterator in interface Iterable<I>

reference

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

Specified by:

reference in interface ReferencesSelector

references

public final <X> References<X> references(org.microbean.assign.AttributedType rType)

Specified by:

references in interface ReferencesSelector

register

public final boolean register(Object reference,
 DestructorRegistry.Destructor destructor)

Description copied from interface: DestructorRegistry

Registers the supplied contextual instance such that at some future moment, or perhaps not at all, the supplied DestructorRegistry.Destructor will be run to destroy it idempotently, and returns true if and only if the registration was successful.

Specified by:

register in interface DestructorRegistry

Parameters:

reference - a contextual instance; may be null in which case no action will be taken and false will be returned

destructor - a DestructorRegistry.Destructor; may be null in which case no action will be taken and false will be returned

Returns:

true if and only if registration was successful; false otherwise

See Also:

• DestructorRegistry.Destructor

size

public final int size()

Specified by:

size in interface References<I>