Package io.micronaut.runtime.context.scope.refresh

Class RefreshScope

java.lang.Object

io.micronaut.runtime.context.scope.refresh.RefreshScope

All Implemented Interfaces:

ApplicationEventListener<RefreshEvent>, LifeCycle<RefreshScope>, CustomScope<Refreshable>, Ordered, Closeable, AutoCloseable, EventListener

@Singleton
@Requires(notEnv={"function","android"})
public class RefreshScope
extends Object
implements CustomScope<Refreshable>, LifeCycle<RefreshScope>, ApplicationEventListener<RefreshEvent>, Ordered

Implementation of Refreshable.

Since:

1.0

Author:

Graeme Rocher

See Also:

• Refreshable
• RefreshEvent

Field Summary

Fields

Modifier and Type	Field	Description
static final int	POSITION

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
RefreshScope(BeanContext beanContext)

Method Summary

Modifier and Type	Method	Description
Class<Refreshable>	annotationType()
<T> Optional<BeanRegistration<T>>	findBeanRegistration(T bean)	Get the BeanDefinition for the given bean.
protected ReadWriteLock	getLock(Object object)
<T> T	getOrCreate(BeanCreationContext<T> creationContext)	Resolve an object from the given scope.
int	getOrder()
boolean	isRunning()
void	onApplicationEvent(RefreshEvent event)	Handle an application event.
final void	onRefreshEvent(RefreshEvent event)	Handle a RefreshEvent synchronously.
<T> Optional<T>	remove(BeanIdentifier identifier)	Remove a bean definition from the scope.
RefreshScope	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.event.ApplicationEventListener

supports

Methods inherited from interface io.micronaut.context.scope.CustomScope

findBeanRegistration

Methods inherited from interface io.micronaut.context.LifeCycle

close, refresh, start

Field Details

POSITION

public static final int POSITION

See Also:

• Constant Field Values

Constructor Details

RefreshScope

public RefreshScope(BeanContext beanContext)

Parameters:

beanContext - The bean context to allow DI of beans annotated with @Inject

Method Details

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle<RefreshScope>

Returns:

Whether the component is running

annotationType

public Class<Refreshable> annotationType()

Specified by:

annotationType in interface CustomScope<Refreshable>

Returns:

The scope annotation type

getOrCreate

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

Description copied from interface: CustomScope

Resolve an object from the given scope.

Specified by:

getOrCreate in interface CustomScope<Refreshable>

Type Parameters:

T - The bean generic type

Parameters:

creationContext - The creation context

Returns:

The bean instance

stop

public RefreshScope stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface LifeCycle<RefreshScope>

Returns:

This lifecycle component

remove

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

Description copied from interface: CustomScope

Remove a bean definition from the scope.

Specified by:

remove in interface CustomScope<Refreshable>

Type Parameters:

T - The generic type

Parameters:

identifier - The BeanIdentifier

Returns:

An Optional of the instance that was destroyed if it exists

onApplicationEvent

public void onApplicationEvent(RefreshEvent event)

Description copied from interface: ApplicationEventListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationEventListener<RefreshEvent>

Parameters:

event - the event to respond to

onRefreshEvent

public final void onRefreshEvent(RefreshEvent event)

Handle a RefreshEvent synchronously. This method blocks unlike onApplicationEvent(RefreshEvent).

Parameters:

event - The event

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).

findBeanRegistration

public <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<Refreshable>

Type Parameters:

T - The bean generic type

Parameters:

bean - The bean

Returns:

The bean definition if it can be resolved

getLock

protected ReadWriteLock getLock(Object object)

Parameters:

object - The bean

Returns:

The lock on the object