javax.enterprise.inject.spi.Bean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdi-api Show documentation

APIs for CDI (Contexts and Dependency Injection for Java EE)

There is a newer version: 2.0.SP1

/*
 * 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 javax.enterprise.inject.spi;

import java.util.Set;

import javax.enterprise.context.spi.Contextual;
import javax.enterprise.context.spi.CreationalContext;

/**
 * 
 * Represents an {@linkplain javax.enterprise.inject enabled bean}. This interface defines everything the container needs to
 * manage instances of the bean.
 * 
 * 
 * @author Gavin King
 * @author David Allen
 * @param  the class of the bean instance
 */
public interface Bean extends Contextual, BeanAttributes {

    /**
     * The bean {@linkplain Class class} of the managed bean or session bean or of the bean that declares the producer method or
     * field.
     * 
     * @return the bean {@linkplain Class class}
     */
    public Class getBeanClass();

    /**
     * Obtains the {@link javax.enterprise.inject.spi.InjectionPoint} objects representing injection points of the bean, that
     * will be validated by the container at initialization time.
     * 
     * @return the set of {@linkplain javax.enterprise.inject.spi.InjectionPoint injection points} of the bean
     */
    public Set getInjectionPoints();

    /**
     * 
     * Determines if {@link javax.enterprise.context.spi.Contextual#create(CreationalContext)} sometimes return a null value.
     * 
     * 
     * 
     * As of CDI 1.1 this method is deprecated and can safely always return false.
     * 
     * 
     * @return true if the {@code create()} method may return a null value, and false otherwise
     */
    public boolean isNullable();

}