org.springframework.data.util.BeanLookup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-commons Show documentation
There is a newer version: 3.4.0
/*
 * Copyright 2018-2024 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.data.util;

import java.util.Map;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.ListableBeanFactory;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
 * Simple helper to allow lenient lookup of beans of a given type from a {@link ListableBeanFactory}. This is not user
 * facing API but a mere helper for Spring Data configuration code.
 *
 * @author Oliver Gierke
 * @since 2.1
 * @soundtrack Dave Matthews Band - Bartender (DMB Live 25)
 */
public abstract class BeanLookup {

	private BeanLookup() {}

	/**
	 * Returns a {@link Lazy} for the unique bean of the given type from the given {@link BeanFactory} (which needs to be
	 * a {@link ListableBeanFactory}). The lookup will produce a {@link NoUniqueBeanDefinitionException} in case multiple
	 * beans of the given type are available in the given {@link BeanFactory}.
	 *
	 * @param type must not be {@literal null}.
	 * @param beanFactory the {@link BeanFactory} to lookup the bean from.
	 * @return a {@link Lazy} for the unique bean of the given type or the instance provided by the fallback in case no
	 *         bean of the given type can be found.
	 */
	public static  Lazy lazyIfAvailable(Class type, BeanFactory beanFactory) {

		Assert.notNull(type, "Type must not be null");
		Assert.isInstanceOf(ListableBeanFactory.class, beanFactory);

		return Lazy.of(() -> lookupBean(type, (ListableBeanFactory) beanFactory));
	}

	/**
	 * Looks up the unique bean of the given type from the given {@link ListableBeanFactory}.
	 *
	 * @param type must not be {@literal null}.
	 * @param beanFactory must not be {@literal null}.
	 * @return
	 */
	@Nullable
	private static  T lookupBean(Class type, ListableBeanFactory beanFactory) {

		Map names = beanFactory.getBeansOfType(type, false, false);

		switch (names.size()) {

			case 0:
				return null;
			case 1:
				return names.values().iterator().next();
			default:
				throw new NoUniqueBeanDefinitionException(type, names.keySet());
		}
	}
}