jakarta.enterprise.inject.Default Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.jakartaee-api Show documentation
Jakarta EE Platform API
There is a newer version: 11.0.0-M4
Show newest version
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat, Inc., 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 jakarta.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 jakarta.enterprise.event.Event;
import jakarta.enterprise.util.AnnotationLiteral;
import jakarta.inject.Qualifier;

/**
 * 
 * The default qualifier type.
 * 
 *
 * 
 * If a bean does not explicitly declare a qualifier other than {@link jakarta.inject.Named @Named}, the bean has the
 * qualifier @Default.
 * 
 *
 * 
 * If an injection point declares no qualifier, the injection point has exactly one qualifier, the default qualifier
 * @Default.
 * 
 *
 * 
 * The following are equivalent:
 * 
 *
 *  * @ConversationScoped
 * public class Order {
 *
 *     private Product product;
 *     private User customer;
 *
 *     @Inject
 *     public void init(@Selected Product product, User customer) {
 *         this.product = product;
 *         this.customer = customer;
 *     }
 *
 * }
 * 
 *
 *  * @Default
 * @ConversationScoped
 * public class Order {
 *
 *     private Product product;
 *     private User customer;
 *
 *     @Inject
 *     public void init(@Selected Product product, @Default User customer) {
 *         this.product = product;
 *         this.customer = customer;
 *     }
 *
 * }
 * 
 *
 * @author Pete Muir
 * @author Gavin King
 */

@Target({ TYPE, METHOD, PARAMETER, FIELD })
@Retention(RUNTIME)
@Documented
@Qualifier
public @interface Default {

    /**
     * Supports inline instantiation of the {@link Default} qualifier.
     *
     * @author Martin Kouba
     * @since 2.0
     * @see Instance
     * @see Event
     */
    public static final class Literal extends AnnotationLiteral implements Default {

        public static final Literal INSTANCE = new Literal();

        private static final long serialVersionUID = 1L;

    }
}