/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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 io.micronaut.inject;

import io.micronaut.core.annotation.AnnotationMetadataProvider;

A BeanConfiguration is a grouping of several BeanDefinition instances. 
Author:
Graeme Rocher
Since:
1.0/**
 * A BeanConfiguration is a grouping of several {@link BeanDefinition} instances.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public interface BeanConfiguration extends AnnotationMetadataProvider, BeanContextConditional {

    
Returns:
The package for the bean configuration/**
     * @return The package for the bean configuration
     */
    Package getPackage();

    
Returns:
The package name this configuration/**
     * @return The package name this configuration
     */
    String getName();

    
The version of this configuration. Note: returns null when called on a configuration not provided by a JAR.
Returns:
The version or null/**
     * The version of this configuration. Note: returns null when called on a configuration not provided by a JAR.
     *
     * @return The version or null
     */
    String getVersion();

    
Check whether the specified bean definition class is within this bean configuration.
Params:
beanDefinitionReference – The bean definition class
Returns:
True if it is/**
     * Check whether the specified bean definition class is within this bean configuration.
     *
     * @param beanDefinitionReference The bean definition class
     * @return True if it is
     */
    boolean isWithin(BeanDefinitionReference beanDefinitionReference);

    
Check whether the specified class is within this bean configuration.
Params:
className – The class name
Returns:
True if it is/**
     * Check whether the specified class is within this bean configuration.
     *
     * @param className The class name
     * @return True if it is
     */
    boolean isWithin(String className);

    
Check whether the specified class is within this bean configuration.
Params:
cls – The class
Returns:
True if it is/**
     * Check whether the specified class is within this bean configuration.
     *
     * @param cls The class
     * @return True if it is
     */
    default boolean isWithin(Class cls) {
        return isWithin(cls.getName());
    }
}