org.glassfish.hk2.api.Proxiable Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012 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 compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.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 designates 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 decision 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.glassfish.hk2.api;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Scope annotations that are also marked with this
* annotation are proxiable. All objects that are
* produced by this scope must be able to be proxied,
* and will be proxied by the system. Whether or
* not individual {@link Descriptor}s in a Proxiable
* scope are proxied can be controlled with
* the {@link UseProxy} annotation. All proxies
* generated by HK2 will implement {@link ProxyCtl}
*
* A scope must not be marked with both {@link Proxiable} and {@link Unproxiable}
*
* @see Proxiable Unproxiable UseProxy ProxyCtl
*
* @author jwells
*
*/
@Retention(RUNTIME)
@Target( { ANNOTATION_TYPE })
public @interface Proxiable {
/**
* This value determines whether or not services in this scope
* should be proxied when being injected into other services of
* the same scope. This value can be overridden by individual
* {@link Descriptor}s in this scope.
*
* @return If true then this service will be proxied even when
* being injected into the same scope. If
* false then this service will NOT be proxied when
* being injected into the same scope (i.e., it cannot
* be used for lazy initialization of the service when
* injected into the same scope)
*/
public boolean proxyForSameScope() default true;
}