-
- All Superinterfaces:
Context
public interface AlterableContext extends Context
Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type. Any instance of
Context
is called a context object.AlterableContext
was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions should implementAlterableContext
instead ofContext
.The context object is responsible for creating and destroying contextual instances by calling operations of
Contextual
. In particular, the context object is responsible for destroying any contextual instance it creates by passing the instance toContextual.destroy(Object, CreationalContext)
. A destroyed instance must not subsequently be returned byget()
. The context object must pass the same instance ofCreationalContext
toContextual.destroy()
that it passed toContextual.create()
when it created the instance.A custom context object may be registered with the container using
AfterBeanDiscovery.addContext(Context)
.- Since:
- 1.1
- Author:
- Pete Muir
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
destroy(Contextual<?> contextual)
Destroy the existing contextual instance.
-
-
-
Method Detail
-
destroy
void destroy(Contextual<?> contextual)
Destroy the existing contextual instance. If there is no existing instance, no action is taken.
- Parameters:
contextual
- the contextual type- Throws:
ContextNotActiveException
- if the context is not active
-
-