javax.enterprise.context.spi.CreationalContext Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package javax.enterprise.context.spi;
/**
* The CreationalContext holds incomplete Bean instances and
* references to all{@link javax.enterprise.context.Dependent} scoped
* contextual instances injected into a {@link javax.enterprise.context.NormalScope}d
* bean.
*
* E.g. consider we create a Contextual Instance of a
* {@link javax.enterprise.context.SessionScoped} UserInformation
* bean which has a dependent injection point
* (e.g. a field private @Inject Helper helper; )
* In that case the CreationalContext of the UserInformation instance
* will contain the information about the helper instance.
* This is needed to properly destroy the helper once the
* UserInformation gets destroyed. In our example this will
* happen at the end of the Session.
*
*
* Attention: If you create a {@link javax.enterprise.context.Dependent} instance
* manually using
* {@link javax.enterprise.inject.spi.BeanManager#getReference(javax.enterprise.inject.spi.Bean, java.lang.reflect.Type, CreationalContext)}
* then you must store away the CreationalContext. You will need it for properly destroying the created instance
* via {@link javax.enterprise.inject.spi.Bean#destroy(Object, CreationalContext)}.
* This is not needed for {@link javax.enterprise.context.NormalScope}d beans as they
* maintain their lifecycle themself!
*
* @version $Rev: 1796096 $ $Date: 2017-05-24 16:27:18 -0400 (Wed, 24 May 2017) $
*/
public interface CreationalContext
{
/**
* Puts new incomplete instance into the creational context.
*
* @param incompleteInstance incomplete webbeans instance
*/
void push(T incompleteInstance);
/**
* Destorys all dependent objects of the instance
* that is being destroyed.
*/
void release();
}