io.micronaut.inject.qualifiers

Class Qualifiers

java.lang.Object

io.micronaut.inject.qualifiers.Qualifiers

public class Qualifiers
extends java.lang.Object

Factory for Bean qualifiers.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
Qualifiers()

Method Summary

Modifier and Type	Method and Description
static <T> Qualifier<T>	any() Allows looking up the first matching instance.
static <T> Qualifier<T>	byAnnotation(java.lang.annotation.Annotation annotation) Build a qualifier for the given annotation.
static <T> Qualifier<T>	byAnnotation(AnnotationMetadata metadata, java.lang.Class<? extends java.lang.annotation.Annotation> type) Build a qualifier for the given annotation.
static <T> Qualifier<T>	byAnnotation(AnnotationMetadata metadata, java.lang.String type) Build a qualifier for the given annotation.
static <T> Qualifier<T>	byAnnotationSimple(AnnotationMetadata metadata, java.lang.String type) Build a qualifier for the given annotation.
static <T> Qualifier<T>	byExactTypeArgumentName(java.lang.String typeName) Build a qualifier for the given generic type argument name.
static <T> Qualifier<T>	byInterceptorBinding(AnnotationMetadata annotationMetadata) Reduces bean definitions by the given interceptor binding.
static <T> Qualifier<T>	byInterceptorBinding(java.util.Collection<java.lang.String> bindingAnnotationNames) Reduces bean definitions by the given interceptor binding.
static <T> Qualifier<T>	byName(java.lang.String name) Build a qualifier for the given name.
static <T> Qualifier<T>	byQualifiers(Qualifier<T>... qualifiers) Build a qualifier from other qualifiers.
static <T> Qualifier<T>	byRepeatableAnnotation(AnnotationMetadata metadata, java.lang.String repeatableType) Builds a qualifier that uses the given repeatable annotation.
static <T> Qualifier<T>	byStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Build a qualifier for the given annotation.
static <T> Qualifier<T>	byStereotype(java.lang.String stereotype) Build a qualifier for the given annotation.
static <T> Qualifier<T>	byType(java.lang.Class... typeArguments) Build a qualifier for the given generic type arguments.
static <T> Qualifier<T>	byTypeArguments(java.lang.Class... typeArguments) Build a qualifier for the given generic type arguments.
static <T> Qualifier<T>	byTypeArgumentsClosest(java.lang.Class... typeArguments) Build a qualifier for the given generic type arguments.
static <T> Qualifier<T>	forArgument(Argument<?> argument) Build a qualifier for the given argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

Qualifiers

public Qualifiers()

Method Detail

any

public static <T> Qualifier<T> any()

Allows looking up the first matching instance.

This qualifier results on NonUniqueBeanException never being thrown as the first matching instance will be returned.

Type Parameters:

T - The generic type

Returns:

The any qualifier.

Since:

3.0.0

See Also:

Any

forArgument

@Nullable
public static <T> Qualifier<T> forArgument(@NonNull
                                                     Argument<?> argument)

Build a qualifier for the given argument.

Type Parameters:

T - The type

Parameters:

argument - The argument

Returns:

The resolved qualifier

byQualifiers

public static <T> Qualifier<T> byQualifiers(Qualifier<T>... qualifiers)

Build a qualifier from other qualifiers.

Type Parameters:

T - The component type

Parameters:

qualifiers - The qualifiers

Returns:

The qualifier

byName

public static <T> Qualifier<T> byName(java.lang.String name)

Build a qualifier for the given name.

Type Parameters:

T - The component type

Parameters:

name - The name

Returns:

The qualifier

byAnnotation

public static <T> Qualifier<T> byAnnotation(java.lang.annotation.Annotation annotation)

Build a qualifier for the given annotation.

Type Parameters:

T - The component type

Parameters:

annotation - The annotation

Returns:

The qualifier

byAnnotation

public static <T> Qualifier<T> byAnnotation(AnnotationMetadata metadata,
                                            java.lang.Class<? extends java.lang.annotation.Annotation> type)

Build a qualifier for the given annotation.

Type Parameters:

T - The component type

Parameters:

metadata - The metadata

type - The annotation type

Returns:

The qualifier

byAnnotation

public static <T> Qualifier<T> byAnnotation(AnnotationMetadata metadata,
                                            java.lang.String type)

Build a qualifier for the given annotation. This qualifier will match a candidate under the following circumstances:

• If the type parameter is Named then the value of the Named annotation within the metadata is used to match the candidate by name
• If the type parameter is Type then the value of the Type annotation is used to match the candidate by type

Type Parameters:

T - The component type

Parameters:

metadata - The metadata

type - The annotation type

Returns:

The qualifier

byRepeatableAnnotation

public static <T> Qualifier<T> byRepeatableAnnotation(AnnotationMetadata metadata,
                                                      java.lang.String repeatableType)

Builds a qualifier that uses the given repeatable annotation.

Type Parameters:

T - The component type

Parameters:

metadata - The metadata

repeatableType - The annotation repeatable type. That is the annotation specified to Repeatable.value()

Returns:

The qualifier

byAnnotationSimple

@Internal
public static <T> Qualifier<T> byAnnotationSimple(AnnotationMetadata metadata,
                                                            java.lang.String type)

Build a qualifier for the given annotation.

Unlike byAnnotation(io.micronaut.core.annotation.AnnotationMetadata, String) this method will not attempt to pick the qualifier strategy to use at runtime based on the passed annotation name.

Type Parameters:

T - The component type

Parameters:

metadata - The metadata

type - The annotation type

Returns:

The qualifier

Since:

3.1.0

byStereotype

public static <T> Qualifier<T> byStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)

Build a qualifier for the given annotation.

Type Parameters:

T - The component type

Parameters:

stereotype - The stereotype

Returns:

The qualifier

byStereotype

public static <T> Qualifier<T> byStereotype(java.lang.String stereotype)

Build a qualifier for the given annotation.

Type Parameters:

T - The component type

Parameters:

stereotype - The stereotype

Returns:

The qualifier

Since:

3.0.0

byTypeArguments

public static <T> Qualifier<T> byTypeArguments(java.lang.Class... typeArguments)

Build a qualifier for the given generic type arguments.

Type Parameters:

T - The component type

Parameters:

typeArguments - The generic type arguments

Returns:

The qualifier

byExactTypeArgumentName

@NonNull
public static <T> Qualifier<T> byExactTypeArgumentName(@NonNull
                                                                java.lang.String typeName)

Build a qualifier for the given generic type argument name.

Type Parameters:

T - The component type

Parameters:

typeName - The name of the generic type argument

Returns:

The qualifier

Since:

3.0.0

byTypeArgumentsClosest

public static <T> Qualifier<T> byTypeArgumentsClosest(java.lang.Class... typeArguments)

Build a qualifier for the given generic type arguments. Only the closest matches will be returned.

Type Parameters:

T - The component type

Parameters:

typeArguments - The generic type arguments

Returns:

The qualifier

byType

public static <T> Qualifier<T> byType(java.lang.Class... typeArguments)

Build a qualifier for the given generic type arguments.

Type Parameters:

T - The component type

Parameters:

typeArguments - The generic type arguments

Returns:

The qualifier

byInterceptorBinding

@NonNull
public static <T> Qualifier<T> byInterceptorBinding(@NonNull
                                                             AnnotationMetadata annotationMetadata)

Reduces bean definitions by the given interceptor binding.

Type Parameters:

T - The bean type

Parameters:

annotationMetadata - The annotation metadata

Returns:

The qualifier

byInterceptorBinding

@NonNull
public static <T> Qualifier<T> byInterceptorBinding(@NonNull
                                                             java.util.Collection<java.lang.String> bindingAnnotationNames)

Reduces bean definitions by the given interceptor binding.

Type Parameters:

T - The bean type

Parameters:

bindingAnnotationNames - The binding annotation names

Returns:

The qualifier

Since:

3.0.0