com.sun.jersey.api.core.InjectParam Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2011 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
 * http://glassfish.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 com.sun.jersey.api.core;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
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;

/**
 * Used to annotate fields, methods or parameters that shall be injected with
 * instances obtained from Jersey or registered IoC component provider
 * factories that provide support for Guice, Spring or CDI.
 * 
 * When Jersey is used without IoC component provider support this annotation
 * provides basic injection support of beans. References to beans may be 
 * obtained be they existing references to instances of resources or just beans
 * that have JAX-RS/Jersey artifacts injected on them.
 * 
 * When Jersey is used with an IoC component provider, such as Guice or CDI,
 * this annotation may be used in conjunction with the Guice or JSR 330-based
 * @Inject when references to beans are obtained as parameters of
 * resource methods, sub-resource methods or sub-resource locator methods.
 *
 * @author [email protected]
 */
@Target({PARAMETER, METHOD, FIELD})
@Retention(RUNTIME)
@Documented
public @interface InjectParam {
    /**
     * @return the name of the object to inject, by default the name
     *         is the class name of the type that is injected.
     */
    String value() default "";
}