Interface Qualifier

All Superinterfaces:

Annotation, Comparable<Annotation>, Prototype.Api

All Known Implementing Classes:

Qualifier.BuilderBase.QualifierImpl

public interface Qualifier
extends Prototype.Api, Annotation

Represents a qualifier annotation (a specific case of annotations, annotated with Service.Qualifier).

See Also:

• Service.Qualifier
• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Qualifier.Builder	Fluent API builder for Qualifier.
static class	Qualifier.BuilderBase<BUILDER extends Qualifier.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends Qualifier>	Fluent API builder base for Qualifier.

Field Summary

Fields

Modifier and Type	Field	Description
static final Qualifier	CREATE_FOR_NAME	Represents a qualifier used for injecting name of Service.PerInstance instances.
static final Qualifier	DEFAULT_NAMED	Represents an instance named with the default name: "@default".
static final String	VALUE_PROPERTY	The "value" property name.
static final Qualifier	WILDCARD_NAMED	Represents a wildcard Service.Named qualifier.

Method Summary

Static Methods

Modifier and Type	Method	Description
static Qualifier.Builder	builder()	Create a new fluent API builder to customize configuration.
static Qualifier.Builder	builder(Qualifier instance)	Create a new fluent API builder from an existing instance.
static Qualifier	create()	Create a new instance with default values.
static Qualifier	create(Annotation annotation)	Creates a qualifier from an annotation.
static Qualifier	create(TypeName qualifierType)	Creates a qualifier from an annotation.
static Qualifier	create(TypeName qualifierType, String value)	Creates a qualifier with a value from an annotation.
static Qualifier	create(Class<? extends Annotation> qualifierType)	Creates a qualifier from an annotation.
static Qualifier	create(Class<? extends Annotation> qualifierType, String value)	Creates a qualifier with a value from an annotation.
static Qualifier	createNamed(Service.Named name)	Creates a Service.Named qualifier.
static Qualifier	createNamed(Service.NamedByType name)	Creates a Service.Named qualifier.
static Qualifier	createNamed(Class<?> className)	Creates a Service.Named qualifier from a class name.
static Qualifier	createNamed(String name)	Creates a Service.Named qualifier.

Methods inherited from interface Annotation

annotationValue, annotationValue, annotationValues, annotationValues, booleanValue, booleanValue, booleanValues, booleanValues, byteValue, byteValue, byteValues, byteValues, charValue, charValue, charValues, charValues, classValue, classValue, classValues, classValues, compareTo, doubleValue, doubleValue, doubleValues, doubleValues, enumValue, enumValue, enumValues, enumValues, floatValue, floatValue, floatValues, floatValues, getValue, hasMetaAnnotation, intValue, intValue, intValues, intValues, longValue, longValue, longValues, longValues, metaAnnotations, objectValue, objectValue, originatingElement, properties, property, property, shortValue, shortValue, shortValues, shortValues, stringValue, stringValue, stringValues, stringValues, typeName, typeValue, typeValue, typeValues, typeValues, value

Modifier and Type	Method	Description
default Optional<Annotation>	annotationValue()	Typed value of the property "value".
default Optional<Annotation>	annotationValue(String property)	Typed value of a named property.
default Optional<List<Annotation>>	annotationValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Annotation>>	annotationValues(String property)	Typed values of a property that is defined as an array.
default Optional<Boolean>	booleanValue()	Typed value of the property "value".
default Optional<Boolean>	booleanValue(String property)	Typed value of a named property.
default Optional<List<Boolean>>	booleanValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Boolean>>	booleanValues(String property)	Typed values of a property that is defined as an array.
default Optional<Byte>	byteValue()	Typed value of the property "value".
default Optional<Byte>	byteValue(String property)	Typed value of a named property.
default Optional<List<Byte>>	byteValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Byte>>	byteValues(String property)	Typed values of a property that is defined as an array.
default Optional<Character>	charValue()	Typed value of the property "value".
default Optional<Character>	charValue(String property)	Typed value of a named property.
default Optional<List<Character>>	charValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Character>>	charValues(String property)	Typed values of a property that is defined as an array.
default Optional<Class<?>>	classValue()	Typed value of the property "value".
default Optional<Class<?>>	classValue(String property)	Typed value of a named property.
default Optional<List<Class<?>>>	classValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Class<?>>>	classValues(String property)	Typed values of a property that is defined as an array.
default int	compareTo(Annotation o)
default Optional<Double>	doubleValue()	Typed value of the property "value".
default Optional<Double>	doubleValue(String property)	Typed value of a named property.
default Optional<List<Double>>	doubleValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Double>>	doubleValues(String property)	Typed values of a property that is defined as an array.
default <T extends Enum<T>> Optional<T>	enumValue(Class<T> type)	Typed value of the property "value".
default <T extends Enum<T>> Optional<T>	enumValue(String property, Class<T> type)	Typed value of a named property.
default <T extends Enum<T>> Optional<List<T>>	enumValues(Class<T> type)	Typed value of the property "value" that is defined as an array.
default <T extends Enum<T>> Optional<List<T>>	enumValues(String property, Class<T> type)	Typed values of a property that is defined as an array.
default Optional<Float>	floatValue()	Typed value of the property "value".
default Optional<Float>	floatValue(String property)	Typed value of a named property.
default Optional<List<Float>>	floatValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Float>>	floatValues(String property)	Typed values of a property that is defined as an array.
default Optional<String>	getValue(String property)	Get a value of an annotation property.
default boolean	hasMetaAnnotation(TypeName annotationType)	Check if Annotation.metaAnnotations() contains an annotation of the provided type.
default Optional<Integer>	intValue()	Typed value of the property "value".
default Optional<Integer>	intValue(String property)	Typed value of a named property.
default Optional<List<Integer>>	intValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Integer>>	intValues(String property)	Typed values of a property that is defined as an array.
default Optional<Long>	longValue()	Typed value of the property "value".
default Optional<Long>	longValue(String property)	Typed value of a named property.
default Optional<List<Long>>	longValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Long>>	longValues(String property)	Typed values of a property that is defined as an array.
List<Annotation>	metaAnnotations()	A list of inherited annotations (from the whole hierarchy).
default Optional<Object>	objectValue()	Value of the annotation as an object.
default Optional<Object>	objectValue(String property)	Value of the annotation property as an object.
Optional<Object>	originatingElement()	The element used to create this instance.
Map<String, AnnotationProperty>	properties()	Properties defined on this annotation.
default Optional<AnnotationProperty>	property()	Annotation property for the "value" property.
default Optional<AnnotationProperty>	property(String property)	Annotation property for the defined name.
default Optional<Short>	shortValue()	Typed value of the property "value".
default Optional<Short>	shortValue(String property)	Typed value of a named property.
default Optional<List<Short>>	shortValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<Short>>	shortValues(String property)	Typed values of a property that is defined as an array.
default Optional<String>	stringValue()	Typed value of the property "value".
default Optional<String>	stringValue(String property)	Typed value of a named property.
default Optional<List<String>>	stringValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<String>>	stringValues(String property)	Typed values of a property that is defined as an array.
TypeName	typeName()	The type name, e.g., Objects -> "java.util.Objects".
default Optional<TypeName>	typeValue()	Typed value of the property "value".
default Optional<TypeName>	typeValue(String property)	Typed value of a named property.
default Optional<List<TypeName>>	typeValues()	Typed value of the property "value" that is defined as an array.
default Optional<List<TypeName>>	typeValues(String property)	Typed values of a property that is defined as an array.
default Optional<String>	value()	The value property.

Field Details

CREATE_FOR_NAME

static final Qualifier CREATE_FOR_NAME

Represents a qualifier used for injecting name of Service.PerInstance instances.

DEFAULT_NAMED

static final Qualifier DEFAULT_NAMED

Represents an instance named with the default name: "@default".

WILDCARD_NAMED

static final Qualifier WILDCARD_NAMED

Represents a wildcard Service.Named qualifier.

VALUE_PROPERTY

static final String VALUE_PROPERTY

The "value" property name.

See Also:

• Constant Field Values

Method Details

builder

static Qualifier.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static Qualifier.Builder builder(Qualifier instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static Qualifier create()

Create a new instance with default values.

Returns:

a new instance

create

static Qualifier create(Class<? extends Annotation> qualifierType)

Creates a qualifier from an annotation.

Parameters:

qualifierType - the qualifier type

Returns:

qualifier

create

static Qualifier create(Class<? extends Annotation> qualifierType,
 String value)

Creates a qualifier with a value from an annotation.

Parameters:

qualifierType - the qualifier type

value - the value property

Returns:

qualifier

create

static Qualifier create(TypeName qualifierType)

Creates a qualifier from an annotation.

Parameters:

qualifierType - the qualifier type

Returns:

qualifier

create

static Qualifier create(TypeName qualifierType,
 String value)

Creates a qualifier with a value from an annotation.

Parameters:

qualifierType - the qualifier type

value - the value property

Returns:

qualifier

create

static Qualifier create(Annotation annotation)

Creates a qualifier from an annotation.

Parameters:

annotation - the qualifier annotation

Returns:

qualifier

createNamed

static Qualifier createNamed(String name)

Creates a Service.Named qualifier.

Parameters:

name - the name

Returns:

named qualifier

createNamed

static Qualifier createNamed(Service.Named name)

Creates a Service.Named qualifier.

Parameters:

name - the name

Returns:

named qualifier

createNamed

static Qualifier createNamed(Service.NamedByType name)

Creates a Service.Named qualifier.

Parameters:

name - the name

Returns:

named qualifier

createNamed

static Qualifier createNamed(Class<?> className)

Creates a Service.Named qualifier from a class name.

Parameters:

className - class whose name will be used

Returns:

named qualifier