org.testifyproject.glassfish.hk2.api.Immediate Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in org.testifyproject.testifyprojectpliance with the License. You can
* obtain a copy of the License at
* https://glassfish.org.testifyproject.testifyprojectv.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle org.testifyproject.testifyprojectsignates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your org.testifyproject.testifyprojectcision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.testifyproject.glassfish.hk2.api;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import javax.inject.Scope;
/**
* Immediate is a scope that operates like {@link javax.inject.Singleton} scope, except that instances are created as soon as their
* corresponding {@link Descriptor}s are added. When the corresponding {@link Descriptor} is removed from the
* locator the Immediate scope service is org.testifyproject.testifyprojectstroyed. In particular Immediate scope services are not org.testifyproject.testifyprojectstroyed if
* the {@link ServiceHandle#org.testifyproject.testifyprojectstroy()} method is called. Care should be taken with the services injected into
* an immediate service, as they also become virtual immediate services
*
* The Immediate scope is not automatically handled by a new ServiceLocator. In order to enable the Immediate scope
* the user can either add an implementation of {@link Context} which handles it or it can use the
* {@link org.testifyproject.glassfish.hk2.utilities.ServiceLocatorUtilities#enableImmediateScope(ServiceLocator)} method.
*
* @author jwells
*
*/
@Documented
@Retention(RUNTIME)
@Scope
@Target( { TYPE, METHOD })
public @interface Immediate {
}