io.micronaut.context.scope

Class AbstractConcurrentCustomScope<A extends Annotation>

java.lang.Object

io.micronaut.context.scope.AbstractConcurrentCustomScope<A>

Type Parameters:

A - The annotation type

All Implemented Interfaces:

LifeCycle<AbstractConcurrentCustomScope<A>>, CustomScope<A>, Closeable, AutoCloseable

public abstract class AbstractConcurrentCustomScope<A extends Annotation>
extends Object
implements CustomScope<A>, LifeCycle<AbstractConcurrentCustomScope<A>>, AutoCloseable

Abstract implementation of the custom scope interface that simplifies defining new scopes using the Map interface.

Note this implementation uses a singleReentrantReadWriteLock to lock the entire scope hence it is designed for scopes that will hold a small amount of beans. For implementations that hold many beans it is recommended to use a lock per BeanIdentifier.

Since:

3.0.0

Author:

graemerocher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConcurrentCustomScope(Class<A> annotationType) A custom scope annotation.

Method Summary

Modifier and Type	Method and Description
Class<A>	annotationType()
abstract void	close() Implement the close logic for the scope.
protected void	destroyScope(Map<BeanIdentifier,CreatedBean<?>> scopeMap) Destroys the scope.
protected <T> CreatedBean<T>	doCreate(BeanCreationContext<T> creationContext) Perform creation.
<T> Optional<BeanRegistration<T>>	findBeanRegistration(T bean) Get the BeanDefinition for the given bean.
<T> T	getOrCreate(BeanCreationContext<T> creationContext) Resolve an object from the given scope.
protected abstract Map<BeanIdentifier,CreatedBean<?>>	getScopeMap(boolean forCreation)
protected void	handleDestructionException(BeanDestructionException e) Method that can be overridden to customize what happens on a shutdown error.
<T> Optional<T>	remove(BeanIdentifier identifier) Remove a bean definition from the scope.
AbstractConcurrentCustomScope<A>	stop() Stops the life cycle component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.context.LifeCycle

isRunning, refresh, start

Constructor Detail

AbstractConcurrentCustomScope

protected AbstractConcurrentCustomScope(Class<A> annotationType)

A custom scope annotation.

Parameters:

annotationType - The annotation type

Method Detail

getScopeMap

@NonNull
protected abstract Map<BeanIdentifier,CreatedBean<?>> getScopeMap(boolean forCreation)

Parameters:

forCreation - Whether it is for creation

Returns:

Obtains the scope map, never null

Throws:

IllegalStateException - if the scope map cannot be obtained in the current context

annotationType

public final Class<A> annotationType()

Specified by:

annotationType in interface CustomScope<A extends Annotation>

Returns:

The scope annotation type

close

public abstract void close()

Implement the close logic for the scope.

Specified by:

close in interface LifeCycle<AbstractConcurrentCustomScope<A extends Annotation>>

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

stop

@NonNull
public final AbstractConcurrentCustomScope<A> stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface LifeCycle<AbstractConcurrentCustomScope<A extends Annotation>>

Returns:

This lifecycle component

destroyScope

protected void destroyScope(@Nullable
                            Map<BeanIdentifier,CreatedBean<?>> scopeMap)

Destroys the scope.

Parameters:

scopeMap - Th scope map

getOrCreate

public final <T> T getOrCreate(BeanCreationContext<T> creationContext)

Description copied from interface: CustomScope

Resolve an object from the given scope.

Specified by:

getOrCreate in interface CustomScope<A extends Annotation>

Type Parameters:

T - The bean generic type

Parameters:

creationContext - The creation context

Returns:

The bean instance

doCreate

@NonNull
protected <T> CreatedBean<T> doCreate(@NonNull
                                               BeanCreationContext<T> creationContext)

Perform creation.

Type Parameters:

T - The generic type

Parameters:

creationContext - The creation context

Returns:

Created bean

remove

public final <T> Optional<T> remove(BeanIdentifier identifier)

Description copied from interface: CustomScope

Remove a bean definition from the scope.

Specified by:

remove in interface CustomScope<A extends Annotation>

Type Parameters:

T - The generic type

Parameters:

identifier - The BeanIdentifier

Returns:

An Optional of the instance that was destroyed if it exists

handleDestructionException

protected void handleDestructionException(BeanDestructionException e)

Method that can be overridden to customize what happens on a shutdown error.

Parameters:

e - The exception

findBeanRegistration

public final <T> Optional<BeanRegistration<T>> findBeanRegistration(T bean)

Description copied from interface: CustomScope

Get the BeanDefinition for the given bean.

Specified by:

findBeanRegistration in interface CustomScope<A extends Annotation>

Type Parameters:

T - The bean generic type

Parameters:

bean - The bean

Returns:

The bean definition if it can be resolved