org.testifyproject.glassfish.hk2.api.Self Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of external-docker-client Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012-2015 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.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.testifyproject.glassfish.hk2.api;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * This annotation is placed on an injection point that is to be injected with the {@link ActiveDescriptor} that was used
 * to create the instance.
 * 
 * The following things must be true of injection points annotated with {@link Self}

 * The injection point must have the type {@link ActiveDescriptor}.  The generic type is ignored
 * The injection point must have no qualifiers
 * The injection point must not be annotated {@link org.testifyproject.jvnet.hk2.annotations.Optional}
 * The class must not be getting injected with the {@link ServiceLocator#inject(Object)} method
 * 
 * Furthermore, the {@link ActiveDescriptor} that can be injected have the following restrictions:
 * The {@link ActiveDescriptor} was not pre-reified prior to being bound (i.e. third-party ActiveDescriptors)
 * The {@link ActiveDescriptor} is not a {@link DescriptorType#PROVIDE_METHOD}
 * 
 * A valid injection point that is annotated with {@link Self} will not go through the normal resolution process, and
 * hence cannot be customized.
 * 
 * @author jwells
 *
 */
@Documented
@Retention(RUNTIME)
@Target( { FIELD, PARAMETER } )
public @interface Self {
}