Top Description Methods
jakarta.enterprise.inject.spi

public Interface ProcessAnnotatedType<X>

Known Direct Subinterfaces
jakarta.enterprise.inject.spi.ProcessSyntheticAnnotatedType
Type Parameters
<X>
The class being annotated
Imports
jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator

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.

CDI Lite implementations are not required to provide support for Portable Extensions.

Authors
David Allen, Antoine Sabot-Durand
See Also
AnnotatedType

Method Summary

Modifier and TypeMethod and Description
public AnnotatedTypeConfigurator<X>

Returns:

a non reusable AnnotatedTypeConfigurator to configure the replacing AnnotatedType
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.

public AnnotatedType<X>

Returns:

the AnnotatedType object
getAnnotatedType
()

Returns the AnnotatedType object that will be used by the container to read the declared annotations.

public void
setAnnotatedType(AnnotatedType<X>
the new AnnotatedType object to use
type
)

Replaces the AnnotatedType.

public void
veto()

Forces the container to ignore this type.

Method Detail

configureAnnotatedTypeback to summary
public 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. Each call returns the same AnnotatedTypeConfigurator.

Returns:AnnotatedTypeConfigurator<X>

a non reusable AnnotatedTypeConfigurator to configure the replacing AnnotatedType

Exceptions
IllegalStateException:
if called outside of the observer method invocation
Since
2.0
getAnnotatedTypeback to summary
public AnnotatedType<X> getAnnotatedType()

Returns the AnnotatedType object that will be used by the container to read the declared annotations.

Returns:AnnotatedType<X>

the AnnotatedType object

Exceptions
IllegalStateException:
if called outside of the observer method invocation
setAnnotatedTypeback to summary
public void setAnnotatedType(AnnotatedType<X> type)

Replaces the AnnotatedType.

Parameters
type:AnnotatedType<X>

the new AnnotatedType object to use

Exceptions
IllegalStateException:
if called outside of the observer method invocation
vetoback to summary
public void veto()

Forces the container to ignore this type.

Exceptions
IllegalStateException:
if called outside of the observer method invocation