javax.enterprise.context.spi.AlterableContext Maven / Gradle / Ivy

package javax.enterprise.context.spi;

import javax.enterprise.context.ContextNotActiveException;

/**
 * 
 * Provides an operation for obtaining and destroying contextual instances with a particular scope of any contextual type. Any
 * instance of {@code Context} is called a context object.
 * 
 * 
 * 
 * {@link AlterableContext} was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions
 * should implement {@link AlterableContext} instead of {@link Context}.
 * 
 * 
 * 
 * The context object is responsible for creating and destroying contextual instances by calling operations of
 * {@link javax.enterprise.context.spi.Contextual}. In particular, the context object is responsible for destroying any
 * contextual instance it creates by passing the instance to
 * {@link javax.enterprise.context.spi.Contextual#destroy(Object, CreationalContext)} . A destroyed instance must not
 * subsequently be returned by {@code get()}. The context object must pass the same instance of
 * {@link javax.enterprise.context.spi.CreationalContext} to {@code Contextual.destroy()} that it passed to
 * {@code Contextual.create()} when it created the instance.
 * 
 * 
 * 
 * A custom context object may be registered with the container using
 * {@link javax.enterprise.inject.spi.AfterBeanDiscovery#addContext(Context)}.
 * 
 * 
 * @author Pete Muir
 * @since 1.1
 */
public interface AlterableContext extends Context {

    /**
     * 
     * Destroy the existing contextual instance. If there is no existing instance, no action is taken.
     * 
     * 
     * @param contextual the contextual type
     * @throws ContextNotActiveException if the context is not active
     */
    public void destroy(Contextual contextual);

}