jakarta.enterprise.inject.build.compatible.spi.BeanInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.cdi-api Show documentation
APIs for CDI (Contexts and Dependency Injection for Java)
There is a newer version: 4.1.0
Show newest version
package jakarta.enterprise.inject.build.compatible.spi;

import jakarta.enterprise.lang.model.AnnotationInfo;
import jakarta.enterprise.lang.model.declarations.ClassInfo;
import jakarta.enterprise.lang.model.declarations.FieldInfo;
import jakarta.enterprise.lang.model.declarations.MethodInfo;
import jakarta.enterprise.lang.model.types.Type;
import java.util.Collection;

/**
 * Beans are:
 *
 * 
 * managed beans
 * beans defined by producer methods
 * beans defined by producer fields
 * synthetic beans
 * 
 *
 * Managed beans are also known as class-based beans, while beans defined by producer methods
 * and producer fields are together also known as producer-based beans.
 * 
 * Class-based and producer-based beans directly correspond to a declaration in program source code.
 * Synthetic beans don't and are instead defined through other mechanisms, such as
 * {@linkplain BuildCompatibleExtension extensions}.
 *
 * @since 4.0
 */
public interface BeanInfo {
    /**
     * Returns the {@linkplain ScopeInfo scope} of this bean.
     *
     * @return the {@linkplain ScopeInfo scope} of this bean, never {@code null}
     */
    ScopeInfo scope();

    /**
     * Returns a collection of all {@linkplain Type types} of this bean.
     *
     * @return immutable collection of bean types, never {@code null}
     */
    Collection types();

    /**
     * Returns a collection of this bean's qualifiers, represented as {@link AnnotationInfo}.
     *
     * @return immutable collection of qualifiers, never {@code null}
     */
    Collection qualifiers();

    /**
     * Returns the class that declares this bean.
     * In case of a managed bean, also known as class-based bean, that is the bean class directly.
     * In case of a producer method or field, that is the class that declares the producer method or field.
     * Returns {@code null} if this bean is synthetic.
     *
     * @return {@link ClassInfo} for the class that declares this bean, or {@code null} if this bean is synthetic
     */
    ClassInfo declaringClass();

    /**
     * Returns whether this bean is a managed bean, also known as class-based bean.
     *
     * @return whether this bean is a managed bean
     */
    boolean isClassBean();

    /**
     * Returns whether this bean is defined by a producer method.
     *
     * @return whether this bean is defined by a producer method
     */
    boolean isProducerMethod();

    /**
     * Returns whether this bean is defined by a producer field.
     *
     * @return whether this bean is defined by a producer field
     */
    boolean isProducerField();

    /**
     * Returns whether this bean is synthetic. In other words, whether this bean
     * does not correspond to a declaration in program source code and was created
     * through other means (e.g. using an extension).
     *
     * @return whether this bean is synthetic
     */
    boolean isSynthetic();

    /**
     * Returns the producer {@linkplain MethodInfo method} that defines this bean.
     * Returns {@code null} if this bean is not defined by a producer method.
     *
     * @return producer method that defines this bean, or {@code null} if this bean is not defined by a producer method
     */
    MethodInfo producerMethod();

    /**
     * Returns the producer {@linkplain FieldInfo field} that defines this bean.
     * Returns {@code null} if this bean is not defined by a producer field.
     *
     * @return producer field that defines this bean, or {@code null} if this bean is not defined by a producer field
     */
    FieldInfo producerField();

    /**
     * Returns whether this bean is an {@linkplain jakarta.enterprise.inject.Alternative alternative}.
     *
     * @return whether this bean is an {@linkplain jakarta.enterprise.inject.Alternative alternative}
     */
    boolean isAlternative();

    /**
     * Returns the {@linkplain jakarta.annotation.Priority priority} declared on this bean, or {@code null}
     * if this bean does not declare a priority. Declaring a priority on an alternative bean makes it an enabled
     * alternative. Similarly, declaring a priority on an interceptor makes it an enabled interceptor.
     *
     * @return the priority of this bean, or {@code null} if this bean does not declare a priority
     */
    Integer priority();

    /**
     * Returns the bean name of this bean. A bean name is usually defined
     * using the {@link jakarta.inject.Named @Named} annotation.
     * Returns {@code null} if the bean does not have a name.
     *
     * @return the bean name, or {@code null} if the bean does not have a name
     */
    String name();

    /**
     * Returns the {@linkplain DisposerInfo disposer} method of this producer-based bean.
     * Returns {@code null} if this bean is not a defined by a producer method or a producer field,
     * or if this producer-based bean does not have a corresponding disposer method.
     *
     * @return the {@linkplain DisposerInfo disposer}, or {@code null} if this bean does not have a disposer
     */
    DisposerInfo disposer();

    /**
     * Returns a collection of this bean's {@linkplain StereotypeInfo stereotypes}.
     *
     * @return immutable collection of stereotypes, never {@code null}
     */
    Collection stereotypes();

    /**
     * Returns a collection of this bean's {@linkplain InjectionPointInfo injection points}.
     *
     * @return immutable collection of injection points, never {@code null}
     */
    Collection injectionPoints();

    // ---

    /**
     * Returns whether this bean is an interceptor.
     *
     * @return whether this bean is an interceptor
     */
    default boolean isInterceptor() {
        return false;
    }

    /**
     * Returns this bean as an {@linkplain InterceptorInfo interceptor}.
     *
     * @return this interceptor, never {@code null}
     * @throws IllegalStateException if {@link #isInterceptor()} returns {@code false}
     */
    default InterceptorInfo asInterceptor() {
        throw new IllegalStateException("Not an interceptor");
    }
}