org.springframework.boot.autoconfigure.condition

Annotation Type ConditionalOnBean

@Target(value={TYPE,METHOD})
@Retention(value=RUNTIME)
@Documented
public @interface ConditionalOnBean

Conditional that only matches when the specified bean classes and/or names are already contained in the BeanFactory.

Author:

Phillip Webb

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Annotation>[]	annotation The annotation type decorating a bean that should be checked.
String[]	name The names of beans to check.
SearchStrategy	search Strategy to decide if the application context hierarchy (parent contexts) should be considered.
String[]	type The class type names of bean that should be checked.
Class<?>[]	value The class type of bean that should be checked.

Element Detail

value

public abstract Class<?>[] value

The class type of bean that should be checked. The condition matches when any of the classes specified is contained in the ApplicationContext.

Returns:

the class types of beans to check

Default:

{}

type

public abstract String[] type

The class type names of bean that should be checked. The condition matches when any of the classes specified is contained in the ApplicationContext.

Returns:

the class type names of beans to check

Default:

{}

annotation

public abstract Class<? extends Annotation>[] annotation

The annotation type decorating a bean that should be checked. The condition matches when each class specified is missing from beans in the ApplicationContext.

Returns:

the class types of beans to check

Default:

{}

name

public abstract String[] name

The names of beans to check. The condition matches when any of the bean names specified is contained in the ApplicationContext.

Returns:

the name of beans to check

Default:

{}

search

public abstract SearchStrategy search

Strategy to decide if the application context hierarchy (parent contexts) should be considered.

Returns:

the search strategy

Default:

org.springframework.boot.autoconfigure.condition.SearchStrategy.ALL