Class InterceptingProducer<I>

java.lang.Object

org.microbean.producer.InterceptingProducer<I>

Type Parameters:

I - the contextual instance type

All Implemented Interfaces:

org.microbean.assign.Aggregate, Producer<I>

public class InterceptingProducer<I>
extends Object

A Producer that applies various kinds of interceptions to a delegate Producer.

Author:

Laird Nelson

Field Summary

Fields inherited from interface org.microbean.assign.Aggregate

EMPTY_ASSIGNMENTS, EMPTY_DEPENDENCIES

Constructor Summary

Constructors

Constructor	Description
InterceptingProducer(Domain domain, Qualifiers qualifiers, Producer<I> delegate, InterceptionProxier proxier)	Creates a new InterceptingProducer.

Method Summary

Modifier and Type	Method	Description
SequencedSet<? extends org.microbean.assign.Assignment<?>>	assign(Function<? super org.microbean.assign.AttributedType, ?> f)
final SequencedSet<org.microbean.assign.AttributedElement>	dependencies()	A convenience method that returns an immutable, determinate SequencedSet of AttributedElements consisting of this Producer's production dependencies followed by its initialization dependencies.
final void	dispose(I i, Destruction d)	Disposes of the supplied contextual instance.
SequencedSet<org.microbean.assign.AttributedElement>	initializationDependencies()	Returns an immutable, determinate SequencedSet of AttributedElements representing dependencies required for initialization.
final I	produce(Creation<I> c)	Produces a new contextual instance and returns it by calling the Producer.produce(Id, SequencedSet) method with the return value of an invocation of the Aggregate.assign(Function) method with a reference to the supplied Creation's reference(AttributedType) method.
I	produce(Id id, SequencedSet<? extends org.microbean.assign.Assignment<?>> assignments)	Produces a new contextual instance and returns it, possibly (often) making use of the supplied assignments.
SequencedSet<org.microbean.assign.AttributedElement>	productionDependencies()	Returns an immutable, determinate SequencedSet of AttributedElements representing dependencies required for production.

Methods inherited from class Object

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

Constructor Details

InterceptingProducer

public InterceptingProducer(Domain domain,
 Qualifiers qualifiers,
 Producer<I> delegate,
 InterceptionProxier proxier)

Creates a new InterceptingProducer.

Parameters:

domain - a Domain; must not be null

qualifiers - a Qualifiers; must not be null

delegate - a Producer to which ultimate production will be delegated; must not be null

proxier - an InterceptionProxier; must not be null

Throws:

NullPointerException - if any argument is null

Method Details

dependencies

public final SequencedSet<org.microbean.assign.AttributedElement> dependencies()

Description copied from interface: Producer

A convenience method that returns an immutable, determinate SequencedSet of AttributedElements consisting of this Producer's production dependencies followed by its initialization dependencies.

There is normally no need to override the default implementation of this method.

Specified by:

dependencies in interface org.microbean.assign.Aggregate

Specified by:

dependencies in interface Producer<I>

Returns:

a non-null, immutable, determinate SequencedSet of AttributedElements consisting of this Producer's production dependencies followed by its initialization dependencies

See Also:

• Producer.productionDependencies()
• Producer.initializationDependencies()

dispose

public final void dispose(I i,
 Destruction d)

Description copied from interface: Producer

Disposes of the supplied contextual instance.

The default implementation of this method checks to see if i is an instance of AutoCloseable, and, if so, calls close() on it, throwing any resulting exception as a DisposalException.

Specified by:

dispose in interface Producer<I>

Parameters:

i - a contextual instance produced by this Producer; may be null

d - the Creation that was present at production time; must not be null

produce

public final I produce(Creation<I> c)

Description copied from interface: Producer

Produces a new contextual instance and returns it by calling the Producer.produce(Id, SequencedSet) method with the return value of an invocation of the Aggregate.assign(Function) method with a reference to the supplied Creation's reference(AttributedType) method.

There is normally no need to override the default implementation of this method.

Specified by:

produce in interface Producer<I>

Parameters:

c - a Creation; must not be null

Returns:

a new contextual instance, or null

See Also:

• Producer.produce(Id, SequencedSet)
• Producer.dependencies()

assign

public SequencedSet<? extends org.microbean.assign.Assignment<?>> assign(Function<? super org.microbean.assign.AttributedType, ?> f)

Specified by:

assign in interface org.microbean.assign.Aggregate

initializationDependencies

public SequencedSet<org.microbean.assign.AttributedElement> initializationDependencies()

Description copied from interface: Producer

Returns an immutable, determinate SequencedSet of AttributedElements representing dependencies required for initialization.

Such dependencies may represent initialization method parameters and/or fields.

Contrast initialization dependencies with production dependencies.

Specified by:

initializationDependencies in interface Producer<I>

Returns:

a non-null, immutable, determinate SequencedSet of AttributedElements representing dependencies required for initialization

See Also:

• Producer.productionDependencies()

produce

public I produce(Id id,
 SequencedSet<? extends org.microbean.assign.Assignment<?>> assignments)

Description copied from interface: Producer

Produces a new contextual instance and returns it, possibly (often) making use of the supplied assignments.

Implementations of this method must not call Producer.produce(Creation) or an infinite loop may result.

Specified by:

produce in interface Producer<I>

Parameters:

id - an Id for which production is occurring; must not be null

assignments - a SequencedSet of Assignments this Producer needs to complete production and possibly initialization; must not be null

Returns:

a new contextual instance, or null

productionDependencies

public SequencedSet<org.microbean.assign.AttributedElement> productionDependencies()

Description copied from interface: Producer

Returns an immutable, determinate SequencedSet of AttributedElements representing dependencies required for production.

Such dependencies normally represent constructor parameters.

Contrast production dependencies with initialization dependencies.

Specified by:

productionDependencies in interface Producer<I>

Returns:

a non-null, immutable, determinate SequencedSet of AttributedElements representing dependencies required for production

See Also:

• Producer.initializationDependencies()