io.micronaut.context.scope

Interface CustomScope<A extends Annotation>

Type Parameters:

A - An annotation type

All Known Implementing Classes:

KafkaClientScope, RefreshScope

public interface CustomScope<A extends Annotation>

Represents a custom scope within the BeanContext.

Since:

1.0

Author:

Graeme Rocher

See Also:

Scope

Method Summary

Modifier and Type	Method and Description
Class<A>	annotationType()
default <T> Optional<BeanRegistration<T>>	findBeanRegistration(T bean) Get the BeanDefinition for the given bean.
<T> T	get(BeanResolutionContext resolutionContext, BeanDefinition<T> beanDefinition, BeanIdentifier identifier, Provider<T> provider) Resolve an object from the given scope.
<T> Optional<T>	remove(BeanIdentifier identifier) Remove a bean definition from the scope.

Method Detail

annotationType

Class<A> annotationType()

Returns:

The scope annotation type

get

<T> T get(BeanResolutionContext resolutionContext,
          BeanDefinition<T> beanDefinition,
          BeanIdentifier identifier,
          Provider<T> provider)

Resolve an object from the given scope.

Type Parameters:

T - The bean generic type

Parameters:

resolutionContext - The bean resolution context

beanDefinition - The bean definition

identifier - The BeanIdentifier

provider - The provider that will build the bean definition

Returns:

The bean instance

remove

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

Remove a bean definition from the scope.

Type Parameters:

T - The generic type

Parameters:

identifier - The BeanIdentifier

Returns:

An Optional of the instance if it exists

findBeanRegistration

default <T> Optional<BeanRegistration<T>> findBeanRegistration(T bean)

Get the BeanDefinition for the given bean.

Type Parameters:

T - The bean generic type

Parameters:

bean - The bean

Returns:

The bean definition if it can be resolved