infra.beans.factory.support.BeanDefinitionOverrideException 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.support;

import infra.beans.factory.BeanDefinitionStoreException;
import infra.beans.factory.config.BeanDefinition;

/**
 * Subclass of {@link BeanDefinitionStoreException} indicating an invalid override
 * attempt: typically registering a new definition for the same bean name while
 * {@link StandardBeanFactory#isAllowBeanDefinitionOverriding()} is {@code false}.
 *
 * @author Juergen Hoeller
 * @author TODAY 2021/10/1 15:53
 * @see StandardBeanFactory#setAllowBeanDefinitionOverriding
 * @see StandardBeanFactory#registerBeanDefinition
 * @since 4.0
 */
public class BeanDefinitionOverrideException extends BeanDefinitionStoreException {

  private final BeanDefinition beanDefinition;

  private final BeanDefinition existingDefinition;

  /**
   * Create a new BeanDefinitionOverrideException for the given new and existing definition.
   *
   * @param beanName the name of the bean
   * @param beanDefinition the newly registered bean definition
   * @param existingDefinition the existing bean definition for the same name
   */
  public BeanDefinitionOverrideException(String beanName, BeanDefinition beanDefinition, BeanDefinition existingDefinition) {
    super((Throwable) null, beanName, "Cannot register bean definition [%s] for bean '%s' since there is already [%s] bound."
            .formatted(beanDefinition, beanName, existingDefinition));
    this.beanDefinition = beanDefinition;
    this.existingDefinition = existingDefinition;
  }

  /**
   * Return the newly registered bean definition.
   */
  public BeanDefinition getBeanDefinition() {
    return this.beanDefinition;
  }

  /**
   * Return the existing bean definition for the same name.
   */
  public BeanDefinition getExistingDefinition() {
    return this.existingDefinition;
  }

}