javax.enterprise.inject.New Maven / Gradle / Ivy

Go to download
/*
* JBoss, Home of Professional Open Source
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed 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.inject;

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.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.Qualifier;

/**
 * The built-in qualifier type.
 * 
 * The @New qualifier allows the application 
 * to obtain a new instance of a bean which is not bound to 
 * the declared scope, but has had dependency injection 
 * performed.
 *
 *  * @Produces @ConversationScoped 
 * @Special Order getSpecialOrder(@New(Order.class) Order order) {
 *    ...
 *    return order;
 * }
 * 
 *    
 * When the @New qualifier is specified 
 * at an injection point and no 
 * {@link javax.enterprise.inject.New#value() value} 
 * member is explicitly specified, the container defaults 
 * the {@link javax.enterprise.inject.New#value() value} 
 * to the declared type of the injection point. So the 
 * following injection point has qualifier
 * @New(Order.class):
 * 
 *  * @Produces @ConversationScoped 
 * @Special Order getSpecialOrder(@New Order order) { ... }
 * 
 *
 * @author Gavin King
 * @author Pete Muir
 */

@Target( { FIELD, PARAMETER, METHOD, TYPE })
@Retention(RUNTIME)
@Documented
@Qualifier
public @interface New
{
   /**
    * Selects the bean to be injected. The class
    * must be the bean class of an enabled or disabled 
    * bean. The bean class need not be deployed in a
    * bean deployment archive.
    * 
    * @return the bean class of the bean to be injected
    */
   Class value() default New.class;
   
}