infra.beans.factory.aot.BeanFactoryInitializationCode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of today-beans Show documentation

Infra Beans

The newest version!

/*
 * Copyright 2017 - 2024 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see [https://www.gnu.org/licenses/]
 */

package infra.beans.factory.aot;

import infra.aot.generate.GeneratedMethods;
import infra.aot.generate.MethodReference;

/**
 * Interface that can be used to configure the code that will be generated to
 * perform bean factory initialization.
 *
 * @author Phillip Webb
 * @author Stephane Nicoll
 * @see BeanFactoryInitializationAotContribution
 * @since 4.0
 */
public interface BeanFactoryInitializationCode {

  /**
   * The recommended variable name to use to refer to the bean factory.
   */
  String BEAN_FACTORY_VARIABLE = "beanFactory";

  /**
   * Get the {@link GeneratedMethods} used by the initializing code.
   *
   * @return the generated methods
   */
  GeneratedMethods getMethods();

  /**
   * Add an initializer method call. An initializer can use a flexible signature,
   * using any of the following:
   * 
   * {@code StandardBeanFactory}, or {@code ConfigurableBeanFactory}
   * to use the bean factory.
   * {@code ConfigurableEnvironment} or {@code Environment} to access the
   * environment.
   * {@code ResourceLoader} to load resources.
   * 
   *
   * @param methodReference a reference to the initialize method to call.
   */
  void addInitializer(MethodReference methodReference);

}