org.springframework.beans.factory.NoUniqueBeanDefinitionException Maven / Gradle / Ivy
/*
* Copyright 2002-2018 the original author or 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 org.springframework.beans.factory;
import java.util.Arrays;
import java.util.Collection;
import org.springframework.core.ResolvableType;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;
/**
* Exception thrown when a {@code BeanFactory} is asked for a bean instance for which
* multiple matching candidates have been found when only one matching bean was expected.
*
* @author Juergen Hoeller
* @since 3.2.1
* @see BeanFactory#getBean(Class)
*/
@SuppressWarnings("serial")
public class NoUniqueBeanDefinitionException extends NoSuchBeanDefinitionException {
private final int numberOfBeansFound;
@Nullable
private final Collection beanNamesFound;
/**
* Create a new {@code NoUniqueBeanDefinitionException}.
* @param type required type of the non-unique bean
* @param numberOfBeansFound the number of matching beans
* @param message detailed message describing the problem
*/
public NoUniqueBeanDefinitionException(Class type, int numberOfBeansFound, String message) {
super(type, message);
this.numberOfBeansFound = numberOfBeansFound;
this.beanNamesFound = null;
}
/**
* Create a new {@code NoUniqueBeanDefinitionException}.
* @param type required type of the non-unique bean
* @param beanNamesFound the names of all matching beans (as a Collection)
*/
public NoUniqueBeanDefinitionException(Class type, Collection beanNamesFound) {
super(type, "expected single matching bean but found " + beanNamesFound.size() + ": " +
StringUtils.collectionToCommaDelimitedString(beanNamesFound));
this.numberOfBeansFound = beanNamesFound.size();
this.beanNamesFound = beanNamesFound;
}
/**
* Create a new {@code NoUniqueBeanDefinitionException}.
* @param type required type of the non-unique bean
* @param beanNamesFound the names of all matching beans (as an array)
*/
public NoUniqueBeanDefinitionException(Class type, String... beanNamesFound) {
this(type, Arrays.asList(beanNamesFound));
}
/**
* Create a new {@code NoUniqueBeanDefinitionException}.
* @param type required type of the non-unique bean
* @param beanNamesFound the names of all matching beans (as a Collection)
* @since 5.1
*/
public NoUniqueBeanDefinitionException(ResolvableType type, Collection beanNamesFound) {
super(type, "expected single matching bean but found " + beanNamesFound.size() + ": " +
StringUtils.collectionToCommaDelimitedString(beanNamesFound));
this.numberOfBeansFound = beanNamesFound.size();
this.beanNamesFound = beanNamesFound;
}
/**
* Create a new {@code NoUniqueBeanDefinitionException}.
* @param type required type of the non-unique bean
* @param beanNamesFound the names of all matching beans (as an array)
* @since 5.1
*/
public NoUniqueBeanDefinitionException(ResolvableType type, String... beanNamesFound) {
this(type, Arrays.asList(beanNamesFound));
}
/**
* Return the number of beans found when only one matching bean was expected.
* For a NoUniqueBeanDefinitionException, this will usually be higher than 1.
* @see #getBeanType()
*/
@Override
public int getNumberOfBeansFound() {
return this.numberOfBeansFound;
}
/**
* Return the names of all beans found when only one matching bean was expected.
* Note that this may be {@code null} if not specified at construction time.
* @since 4.3
* @see #getBeanType()
*/
@Nullable
public Collection getBeanNamesFound() {
return this.beanNamesFound;
}
}