javax.enterprise.inject.spi.builder

Interface AnnotatedTypeConfigurator<T>

Type Parameters:

T - the class represented by the configured AnnotatedType

public interface AnnotatedTypeConfigurator<T>

This API is an helper to configure a new AnnotatedType instance. The CDI container must provides an implementation of this interface. AnnotatedTypeConfigurator is not reusable. This configurator is not thread safe and shall not be used concurrently.

Since:

2.0

Author:

Antoine Sabot-Durand

See Also:

BeforeBeanDiscovery.addAnnotatedType(String), AfterTypeDiscovery.addAnnotatedType(String), ProcessAnnotatedType.configureAnnotatedType()

Method Summary

Modifier and Type	Method and Description
AnnotatedTypeConfigurator<T>	addToConstructor(AnnotatedConstructor<T> constructor, Annotation annotation) Add an annotation to the specified constructor.
AnnotatedTypeConfigurator<T>	addToConstructor(Constructor<T> constructor, Annotation annotation) Add an annotation to the specified constructor.
AnnotatedTypeConfigurator<T>	addToConstructorParameter(Constructor<T> constructor, int position, Annotation annotation) Add an annotation to the specified constructor parameter.
AnnotatedTypeConfigurator<T>	addToField(AnnotatedField<? super T> field, Annotation annotation) Add an annotation to the specified field.
AnnotatedTypeConfigurator<T>	addToField(Field field, Annotation annotation) Add an annotation to the specified field.
AnnotatedTypeConfigurator<T>	addToMethod(AnnotatedMethod<? super T> method, Annotation annotation) Add an annotation to the specified method.
AnnotatedTypeConfigurator<T>	addToMethod(Method method, Annotation annotation) Add an annotation to the specified method.
AnnotatedTypeConfigurator<T>	addToMethodParameter(Method method, int position, Annotation annotation) Add an annotation to the specified method parameter.
AnnotatedTypeConfigurator<T>	addToParameter(AnnotatedParameter<? super T> parameter, Annotation annotation) Add an annotation to the specified parameter.
AnnotatedTypeConfigurator<T>	addToType(Annotation annotation) Add an annotation to the type declaration.
Class<T>	getJavaClass() getter for the class represented by the AnnotatedType to configure
AnnotatedTypeConfigurator<T>	overrideConstructorParameterType(Constructor<T> constructor, int position, Type type) Override the declared type of a constructor parameter
AnnotatedTypeConfigurator<T>	overrideFieldType(AnnotatedField<? super T> field, Type type) Override the declared type of a field
AnnotatedTypeConfigurator<T>	overrideFieldType(Field field, Type type) Override the declared type of a field
AnnotatedTypeConfigurator<T>	overrideMethodParameterType(Method method, int position, Type type) Override the declared type of a method parameter
AnnotatedTypeConfigurator<T>	overrideParameterType(AnnotatedParameter<? super T> parameter, Type type) Override the declared type of a parameter.
<U extends T> AnnotatedTypeConfigurator<T>	read(AnnotatedType<U> type) Reads in from an existing AnnotatedType.
<U extends T> AnnotatedTypeConfigurator<T>	read(AnnotatedType<U> type, boolean overwrite) Reads in from an existing AnnotatedType.
<U extends T> AnnotatedTypeConfigurator<T>	read(Class<U> type) Reads the annotations from an existing java type.
<U extends T> AnnotatedTypeConfigurator<T>	read(Class<U> type, boolean overwrite) Reads the annotations from an existing java type.
AnnotatedTypeConfigurator<T>	removeFromAll(Annotation annotation) Remove the provided annotation from the type, and all of it's members.
AnnotatedTypeConfigurator<T>	removeFromAll(Class<? extends Annotation> annotationType) Remove annotations from the type, and all of it's members.
AnnotatedTypeConfigurator<T>	removeFromConstructor(AnnotatedConstructor<T> constructor, Class<? extends Annotation> annotationType) Remove an annotation from the specified constructor.
AnnotatedTypeConfigurator<T>	removeFromConstructor(Constructor<T> constructor, Class<? extends Annotation> annotationType) Remove an annotation from the specified constructor.
AnnotatedTypeConfigurator<T>	removeFromConstructorParameter(Constructor<T> constructor, int position, Class<? extends Annotation> annotationType) Remove an annotation from the specified constructor parameter.
AnnotatedTypeConfigurator<T>	removeFromField(AnnotatedField<? super T> field, Class<? extends Annotation> annotationType) Remove an annotation from the specified field.
AnnotatedTypeConfigurator<T>	removeFromField(Field field, Class<? extends Annotation> annotationType) Remove an annotation from the specified field.
AnnotatedTypeConfigurator<T>	removeFromMethod(AnnotatedMethod<? super T> method, Class<? extends Annotation> annotationType) Remove an annotation from the specified method.
AnnotatedTypeConfigurator<T>	removeFromMethod(Method method, Class<? extends Annotation> annotationType) Remove an annotation from the specified method.
AnnotatedTypeConfigurator<T>	removeFromMethodParameter(Method method, int position, Class<? extends Annotation> annotationType) Remove an annotation from the specified method parameter.
AnnotatedTypeConfigurator<T>	removeFromParameter(AnnotatedParameter<? super T> parameter, Class<? extends Annotation> annotationType) Remove an annotation from the specified parameter.
AnnotatedTypeConfigurator<T>	removeFromType(Annotation annotation) Remove an annotation instance from the type
AnnotatedTypeConfigurator<T>	removeFromType(Class<? extends Annotation> annotationType) Remove an annotation class from the type
AnnotatedTypeConfigurator<T>	setType(Class<T> type) set the class represented by the AnnotatedType to configure

Method Detail

addToType

AnnotatedTypeConfigurator<T> addToType(Annotation annotation)

Add an annotation to the type declaration.

Parameters:

annotation - the annotation instance to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

removeFromType

AnnotatedTypeConfigurator<T> removeFromType(Class<? extends Annotation> annotationType)

Remove an annotation class from the type

Parameters:

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null

removeFromType

AnnotatedTypeConfigurator<T> removeFromType(Annotation annotation)

Remove an annotation instance from the type

Parameters:

annotation - the annotation to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

addToField

AnnotatedTypeConfigurator<T> addToField(Field field,
                                        Annotation annotation)

Add an annotation to the specified field. If the field is not already present, it will be added.

Parameters:

field - the field to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

addToField

AnnotatedTypeConfigurator<T> addToField(AnnotatedField<? super T> field,
                                        Annotation annotation)

Add an annotation to the specified field. If the field is not already present, it will be added.

Parameters:

field - the field to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

removeFromField

AnnotatedTypeConfigurator<T> removeFromField(Field field,
                                             Class<? extends Annotation> annotationType)

Remove an annotation from the specified field.

Parameters:

field - the field to remove the annotation from

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null or if the field is not currently declared on the type

removeFromField

AnnotatedTypeConfigurator<T> removeFromField(AnnotatedField<? super T> field,
                                             Class<? extends Annotation> annotationType)

Remove an annotation from the specified field.

Parameters:

field - the field to remove the annotation from

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null or if the field is not currently declared on the type

addToMethod

AnnotatedTypeConfigurator<T> addToMethod(Method method,
                                         Annotation annotation)

Add an annotation to the specified method. If the method is not already present, it will be added.

Parameters:

method - the method to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

addToMethod

AnnotatedTypeConfigurator<T> addToMethod(AnnotatedMethod<? super T> method,
                                         Annotation annotation)

Add an annotation to the specified method. If the method is not already present, it will be added.

Parameters:

method - the method to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

removeFromMethod

AnnotatedTypeConfigurator<T> removeFromMethod(Method method,
                                              Class<? extends Annotation> annotationType)

Remove an annotation from the specified method.

Parameters:

method - the method to remove the annotation from

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null or if the method is not currently declared on the type

removeFromMethod

AnnotatedTypeConfigurator<T> removeFromMethod(AnnotatedMethod<? super T> method,
                                              Class<? extends Annotation> annotationType)

Remove an annotation from the specified method.

Parameters:

method - the method to remove the annotation from

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null or if the method is not currently declared on the type

addToMethodParameter

AnnotatedTypeConfigurator<T> addToMethodParameter(Method method,
                                                  int position,
                                                  Annotation annotation)

Add an annotation to the specified method parameter. If the method is not already present, it will be added. If the method parameter is not already present, it will be added.

Parameters:

method - the method to add the annotation to

position - the position of the parameter to add

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

removeFromMethodParameter

AnnotatedTypeConfigurator<T> removeFromMethodParameter(Method method,
                                                       int position,
                                                       Class<? extends Annotation> annotationType)

Remove an annotation from the specified method parameter.

Parameters:

method - the method to remove the annotation from

position - the position of the parameter to remove

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null, if the method is not currently declared on the type or if the parameter is not declared on the method

addToConstructor

AnnotatedTypeConfigurator<T> addToConstructor(Constructor<T> constructor,
                                              Annotation annotation)

Add an annotation to the specified constructor. If the constructor is not already present, it will be added.

Parameters:

constructor - the constructor to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

addToConstructor

AnnotatedTypeConfigurator<T> addToConstructor(AnnotatedConstructor<T> constructor,
                                              Annotation annotation)

Add an annotation to the specified constructor. If the constructor is not already present, it will be added.

Parameters:

constructor - the constructor to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

removeFromConstructor

AnnotatedTypeConfigurator<T> removeFromConstructor(Constructor<T> constructor,
                                                   Class<? extends Annotation> annotationType)

Remove an annotation from the specified constructor.

Parameters:

constructor - the constructor to add the annotation to

annotationType - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null or if the constructor is not currently declared on the type

removeFromConstructor

AnnotatedTypeConfigurator<T> removeFromConstructor(AnnotatedConstructor<T> constructor,
                                                   Class<? extends Annotation> annotationType)

Remove an annotation from the specified constructor.

Parameters:

constructor - the constructor to add the annotation to

annotationType - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null, if the annotation does not exist on the type or if the constructor is not currently declared on the type

addToConstructorParameter

AnnotatedTypeConfigurator<T> addToConstructorParameter(Constructor<T> constructor,
                                                       int position,
                                                       Annotation annotation)

Add an annotation to the specified constructor parameter. If the constructor is not already present, it will be added. If the constructor parameter is not already present, it will be added.

Parameters:

constructor - the constructor to add the annotation to

position - the position of the parameter to add

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

removeFromConstructorParameter

AnnotatedTypeConfigurator<T> removeFromConstructorParameter(Constructor<T> constructor,
                                                            int position,
                                                            Class<? extends Annotation> annotationType)

Remove an annotation from the specified constructor parameter.

Parameters:

constructor - the constructor to remove the annotation from

position - the position of the parameter to remove

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null, if the constructor is not currently declared on the type or if the parameter is not declared on the constructor

removeFromParameter

AnnotatedTypeConfigurator<T> removeFromParameter(AnnotatedParameter<? super T> parameter,
                                                 Class<? extends Annotation> annotationType)

Remove an annotation from the specified parameter.

Parameters:

parameter - the parameter to remove the annotation from

annotationType - the annotation type to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null, if the callable which declares the parameter is not currently declared on the type or if the parameter is not declared on either a constructor or a method

addToParameter

AnnotatedTypeConfigurator<T> addToParameter(AnnotatedParameter<? super T> parameter,
                                            Annotation annotation)

Add an annotation to the specified parameter. If the callable which declares the parameter is not already present, it will be added. If the parameter is not already present on the callable, it will be added.

Parameters:

parameter - the parameter to add the annotation to

annotation - the annotation to add

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null or if the parameter is not declared on either a constructor or a method

removeFromAll

AnnotatedTypeConfigurator<T> removeFromAll(Class<? extends Annotation> annotationType)

Remove annotations from the type, and all of it's members. If an annotation of the specified type appears on the type declaration, or any of it's members it will be removed.

Parameters:

annotationType - the type of annotation to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotationType is null

removeFromAll

AnnotatedTypeConfigurator<T> removeFromAll(Annotation annotation)

Remove the provided annotation from the type, and all of it's members. If the annotation appears on the type declaration, or any of it's members it will be removed.

Parameters:

annotation - the annotation to remove

Returns:

self

Throws:

IllegalArgumentException - if the annotation is null

read

<U extends T> AnnotatedTypeConfigurator<T> read(AnnotatedType<U> type)

Reads in from an existing AnnotatedType. Any elements not present are added. The javaClass will be read in. If the annotation already exists on that element in the configurator the read annotation will be used.

Parameters:

type - the type to read from

Returns:

self

Throws:

IllegalArgumentException - if type is null

read

<U extends T> AnnotatedTypeConfigurator<T> read(AnnotatedType<U> type,
                                                boolean overwrite)

Reads in from an existing AnnotatedType. Any elements not present are added. The javaClass will be read in if overwrite is true. If the annotation already exists on that element in the configurator, overwrite determines whether the original or read annotation will be used.

Parameters:

type - the type to read from

overwrite - if true, the read annotation will replace any existing annotation

Returns:

self

Throws:

IllegalArgumentException - if type is null

read

<U extends T> AnnotatedTypeConfigurator<T> read(Class<U> type)

Reads the annotations from an existing java type. Annotations already present will be overwritten

Parameters:

type - the type to read from

Returns:

self

Throws:

IllegalArgumentException - if type is null

read

<U extends T> AnnotatedTypeConfigurator<T> read(Class<U> type,
                                                boolean overwrite)

Reads the annotations from an existing java type. If overwrite is true then existing annotations will be overwritten

Parameters:

type - the type to read from

overwrite - if true, the read annotation will replace any existing annotation

Returns:

self

overrideFieldType

AnnotatedTypeConfigurator<T> overrideFieldType(Field field,
                                               Type type)

Override the declared type of a field

Parameters:

field - the field to override the type on

type - the new type of the field

Returns:

self

Throws:

IllegalArgumentException - if field or type is null

overrideFieldType

AnnotatedTypeConfigurator<T> overrideFieldType(AnnotatedField<? super T> field,
                                               Type type)

Override the declared type of a field

Parameters:

field - the field to override the type on

type - the new type of the field

Returns:

self

Throws:

IllegalArgumentException - if field or type is null

overrideMethodParameterType

AnnotatedTypeConfigurator<T> overrideMethodParameterType(Method method,
                                                         int position,
                                                         Type type)

Override the declared type of a method parameter

Parameters:

method - the method to override the parameter type on

position - the position of the parameter to override the type on

type - the new type of the parameter

Returns:

self

Throws:

IllegalArgumentException - if parameter or type is null

overrideConstructorParameterType

AnnotatedTypeConfigurator<T> overrideConstructorParameterType(Constructor<T> constructor,
                                                              int position,
                                                              Type type)

Override the declared type of a constructor parameter

Parameters:

constructor - the constructor to override the parameter type on

position - the position of the parameter to override the type on

type - the new type of the parameter

Returns:

self

Throws:

IllegalArgumentException - if parameter or type is null

overrideParameterType

AnnotatedTypeConfigurator<T> overrideParameterType(AnnotatedParameter<? super T> parameter,
                                                   Type type)

Override the declared type of a parameter.

Parameters:

parameter - the parameter to override the type on

type - the new type of the parameter

Returns:

self

Throws:

IllegalArgumentException - if parameter or type is null

getJavaClass

Class<T> getJavaClass()

getter for the class represented by the AnnotatedType to configure

Returns:

Class represented by the AnnotatedType to configure

setType

AnnotatedTypeConfigurator<T> setType(Class<T> type)

set the class represented by the AnnotatedType to configure

Parameters:

type - the Class represented by the AnnotatedType

Returns:

self