jakarta.enterprise.inject.spi.BeanAttributes 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 2013, 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.spi;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Set;

import jakarta.enterprise.inject.Alternative;
import jakarta.enterprise.inject.Stereotype;

/**
 * The BeanAttributes interface exposes the basic attributes of a bean.
 * 
 * @author Pete Muir
 * @since 1.1
 * @param  the class of the bean instance
 */
public interface BeanAttributes {

    /**
     * Obtains the {@linkplain jakarta.enterprise.inject bean types} of the bean.
     * 
     * @return the {@linkplain jakarta.enterprise.inject bean types}
     */
    public Set getTypes();

    /**
     * Obtains the {@linkplain jakarta.inject.Qualifier qualifiers} of the bean.
     * 
     * @return the {@linkplain jakarta.inject.Qualifier qualifiers}
     */
    public Set getQualifiers();

    /**
     * Obtains the {@linkplain jakarta.enterprise.context scope} of the bean.
     * 
     * @return the {@linkplain jakarta.enterprise.context scope}
     */
    public Class getScope();

    /**
     * Obtains the {@linkplain jakarta.enterprise.inject EL name} of a bean, if it has one.
     * 
     * @return the {@linkplain jakarta.enterprise.inject EL name}
     */
    public String getName();

    /**
     * Obtains the {@linkplain Stereotype stereotypes} of the bean.
     * 
     * @return the set of {@linkplain Stereotype stereotypes}
     */
    public Set> getStereotypes();

    /**
     * Determines if the bean is an {@linkplain Alternative alternative}.
     *
     * A custom implementation of {@link Bean} may implement {@link Prioritized} in order to be selected for the application.
     * {@link Prioritized#getPriority()} determines the priority used to resolve ambiguities.
     *
     * @return true if the bean is an {@linkplain Alternative alternative}, and false
     *         otherwise.
     */
    public boolean isAlternative();

}