WeldAlterableContext (Weld APIs 5.0.Final API)

All Superinterfaces:

jakarta.enterprise.context.spi.AlterableContext, jakarta.enterprise.context.spi.Context

All Known Subinterfaces:

BoundContext<S>, BoundConversationContext, BoundRequestContext, BoundSessionContext, ConversationContext, EjbRequestContext, HttpConversationContext, HttpRequestContext, HttpSessionContext, ManagedContext, RequestContext, SessionContext
```
public interface WeldAlterableContext
extends jakarta.enterprise.context.spi.AlterableContext
```
Enriched version of AlterableContext which allows to capture all instances from given context or to set them to previously obtained values. Most built-in contexts implement this in order to support context propagation. Exception are ApplicationContext which works out of the box and then SingletonContext and DependentContext which are not to be propagated.

Author:

Matej Novotny

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default void`	`clearAndSet(Collection<ContextualInstance<?>> setOfInstances)`	Clears the backing bean store and feeds it with the set of `ContextualInstance` provided as parameter.
`default Collection<ContextualInstance<?>>`	`getAllContextualInstances()`	Retrieves set of `ContextualInstance` within the context.

Methods inherited from interface jakarta.enterprise.context.spi.AlterableContext
destroy

Methods inherited from interface jakarta.enterprise.context.spi.Context
get, get, getScope, isActive

- Method Detail
  - getAllContextualInstances
```
default Collection<ContextualInstance<?>> getAllContextualInstances()
```
    Retrieves set of ContextualInstance within the context. This entails all instances that were created up to this point - Weld creates them lazily so unless some beans were already used, they have not been stored.
    
    Returns:
    
    Set of all ContextualInstance existing in this context
  - clearAndSet
```
default void clearAndSet(Collection<ContextualInstance<?>> setOfInstances)
```
    Clears the backing bean store and feeds it with the set of ContextualInstance provided as parameter. All ContextualInstance have to belong to the same scope as does this WeldAlterableContext otherwise IllegalArgumentException is thrown.
    
    Parameters:
    
    setOfInstances - set of ContextualInstance which are to become the new bean store for this context
    
    Throws:
    
    IllegalArgumentException - if ContextualInstances belong to different scope than this context