/*
 * 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 javax.enterprise.inject.spi.builder.AnnotatedTypeConfigurator;
import java.util.List;

/**
 * This event will get fired after the container has completed the
 * class scanning process and all AnnotatedTypes got discovered
 * from the classpath.
 */
public interface AfterTypeDiscovery
{
    /**
     * This method can be used to remove and add {@link javax.enterprise.inject.Alternative}s,
     * but also to change the sorting order
     * {@link javax.enterprise.inject.Alternative}s which are only enabled in a certain
     * BeanArchive are not included in this list.
     * @return the ordered, mutable List of enabled {@link javax.enterprise.inject.Alternative}s
     */
    List<Class<?>> getAlternatives();

    /**
     * This method can be used to remove and add enabled CDI Interceptors,
     * but also to change the sorting order.
     * Interceptors which are only enabled in a certain BeanArchive are not included in this list.
     * @return the ordered, mutable List of Classes which are annotated with {@link Interceptor}
     *      and globally enabled.
     */
    List<Class<?>> getInterceptors();

    /**
     * This method can be used to remove and add enabled Decorators,
     * but also to change the sorting order.
     * Decorators which are only enabled in a certain BeanArchive are not included in this list.
     * @return the ordered, mutable List of Classes which are annotated with {@link Decorator}
     *      and globally enabled.
     */
    List<Class<?>> getDecorators();

    /**
     * Allows to a synthetic annotated type.
     * This method shall get used if you like to add a new
     * AnnotatedType for a class which already gets scanned by the container.
     * You should provide an unique id if there is already another AnnotatedType
     * for the same class.
     *
     * The AnnotatedTypes added via this method will not get passed
     * to Extensions via {@link ProcessAnnotatedType} but only via
     * {@link ProcessSyntheticAnnotatedType}
     *
     * @param type
     * @param id the unique id or <code>null</code>
     *
     * @see AfterBeanDiscovery#getAnnotatedType(Class, String)
     * @see AfterBeanDiscovery#getAnnotatedTypes(Class)
     *
     */
    void addAnnotatedType(AnnotatedType<?> type, String id);

    /**
     * Returns a new annotated type configurator based on a new bean id and bean class.
     *
     * @param id of the annotated type
     * @param clazz
     * @param <T>
     * @return
     */
    <T> AnnotatedTypeConfigurator<T> addAnnotatedType(String id, Class<T> clazz);
}