X
- The class being annotatedpublic interface ProcessAnnotatedType<X>
The container fires an event of this type for each Java class or interface it discovers in a bean archive, before it reads the declared annotations.
Any observer of this event is permitted to wrap and/or replace the AnnotatedType
by calling either setAnnotatedType(AnnotatedType)
or configureAnnotatedType()
.
If both methods are called within an observer notification an IllegalStateException
is thrown.
The container must use the final value of this property, after all observers have been called, to discover the types and read the annotations of the program elements.
For example, the following observer decorates the AnnotatedType
for every class that is
discovered by the container.
public <T> void decorateAnnotatedType(@Observes ProcessAnnotatedType<T> pat) { pat.setAnnotatedType(decorate(pat.getAnnotatedType())); }
If any observer method of a ProcessAnnotatedType
event throws an exception, the exception is treated as a definition
error by the container.
AnnotatedType
Modifier and Type | Method and Description |
---|---|
AnnotatedTypeConfigurator<X> |
configureAnnotatedType()
Returns an
AnnotatedTypeConfigurator initialized with the AnnotatedType processed by this event
to configure a new AnnotatedType that will replace the original one at the end of the observer invocation. |
AnnotatedType<X> |
getAnnotatedType()
Returns the
AnnotatedType object that will be used by the container to read the
declared annotations. |
void |
setAnnotatedType(AnnotatedType<X> type)
Replaces the
AnnotatedType . |
void |
veto()
Forces the container to ignore this type.
|
AnnotatedType<X> getAnnotatedType()
AnnotatedType
object that will be used by the container to read the
declared annotations.AnnotatedType
objectIllegalStateException
- if called outside of the observer method invocationvoid setAnnotatedType(AnnotatedType<X> type)
AnnotatedType
.type
- the new AnnotatedType
object to useIllegalStateException
- if called outside of the observer method invocationAnnotatedTypeConfigurator<X> configureAnnotatedType()
AnnotatedTypeConfigurator
initialized with the AnnotatedType
processed by this event
to configure a new AnnotatedType that will replace the original one at the end of the observer invocation.
Each call returns the same AnnotatedTypeConfigurator.AnnotatedTypeConfigurator
to configure the replacing AnnotatedTypeIllegalStateException
- if called outside of the observer method invocationvoid veto()
IllegalStateException
- if called outside of the observer method invocationComments to: cdi-dev@eclipse.org.
Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.