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 javaee-api Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Set;

import javax.enterprise.context.spi.Contextual;

/**
 * Reprensts bean instances that are contextual
 * and injectable by the container.
 * 
 * @version $Rev$ $Date$
 *
 * @param  bean representation type
 */
public interface Bean extends Contextual
{
	
    /**
     * Returns api types of a bean.
     * 
     * @return api types of a bean
     */
    public abstract Set getTypes();

    /**
     * Returns qualifiers of a bean.
     * 
     * @return qualifiers of a bean
     */
    public abstract Set getQualifiers();    
    
    /**
     * Returns scope of a bean.
     * 
     * @return scope
     */
    public abstract Class getScope();

    /**
     * Returns name of a bean.
     * 
     * @return name of a bean
     */
    public abstract String getName();

    /**
     * If bean is nullable return true, false
     * otherwise. 
     * 
     * 
     * Nullable means that if producer
     * bean api type is primitive, its nullable property
     * will be false.
     * 
     * 
     * @return true if bean is nullable.
     */
    public abstract boolean isNullable();

    /**
     * Returns all injection points of this bean.
     * 
     * @return injection points
     */
    public abstract Set getInjectionPoints();
    
    /**
     * Returns class of bean.
     * 
     * @return class of bean that it represents
     */
    public abstract Class getBeanClass();
    
    /**
     * Returns bean stereotypes.
     * 
     * @return bean stereotypes
     */
    public Set> getStereotypes();
    
    /**
     * Returns true if declares as policy
     * 
     * @return true if declares as policy
     */
    public boolean isAlternative();

}