jakarta.enterprise.inject.Any 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 built-in qualifier type.
 * 
 *
 * 
 * Every bean has the qualifier @Any, even if it does not explicitly declare this qualifier, except for the
 * special {@link New @New qualified beans}.
 * 
 *
 * 
 * Every event has the qualifier @Any, even if it was raised without explicitly declaration of this qualifier.
 * 
 *
 * 
 * The @Any qualifier allows an injection point to refer to all beans or all events of a certain bean type.
 * 
 *
 *  * @Inject
 * @Any
 * Instance<PaymentProcessor> anyPaymentProcessor;
 * 
 *
 *  * @Inject
 * @Any
 * Event<User> anyUserEvent;
 * 
 *
 *  * @Inject
 * @Delegate
 * @Any
 * Logger logger;
 * 
 *
 * @author Gavin King
 * @author David Allen
 */

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

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

        public static final Literal INSTANCE = new Literal();

        private static final long serialVersionUID = 1L;

    }

}