Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync Javadoc for @⁠TestBean & @⁠MockitoBean with reference manual

Browse Source 
See gh-33701
This commit is contained in:
Sam Brannen
2024-10-28 12:58:33 +01:00
parent 81d89f478a
commit de2c10abcd
2 changed files with 16 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBean.java
View File

@@ -38,10 +38,10 @@ import org.springframework.test.context.bean.override.BeanOverride;
* Alternatively, you can explicitly specify a bean name to replace by setting the
* {@link #value() value} or {@link #name() name} attribute.
*
* <p>A new bean definition will be created if a corresponding bean definition does
* not exist. However, if you would like for the test to fail when a corresponding
* bean definition does not exist, you can set the {@link #enforceOverride()
* enforceOverride} attribute to {@code true}.
* <p>A bean will be created if a corresponding bean does not exist. However, if
* you would like for the test to fail when a corresponding bean does not exist,
* you can set the {@link #enforceOverride() enforceOverride} attribute to {@code true}
* &mdash; for example, {@code @TestBean(enforceOverride = true)}.
*
* <p>The instance is created from a zero-argument static factory method in the
* test class whose return type is compatible with the annotated field. In the
@@ -151,12 +151,11 @@ public @interface TestBean {
String methodName() default "";
/**
* Whether to require the existence of a bean definition for the bean being
* overridden.
* <p>Defaults to {@code false} which means that a new bean definition will
* be created if a corresponding bean definition does not exist.
* Whether to require the existence of the bean being overridden.
* <p>Defaults to {@code false} which means that a bean will be created if a
* corresponding bean does not exist.
* <p>Set to {@code true} to cause an exception to be thrown if a corresponding
* bean definition does not exist.
* bean does not exist.
* @see org.springframework.test.context.bean.override.BeanOverrideStrategy#REPLACE_OR_CREATE
* @see org.springframework.test.context.bean.override.BeanOverrideStrategy#REPLACE
*/

17
spring-test/src/main/java/org/springframework/test/context/bean/override/mockito/MockitoBean.java
View File

@@ -41,10 +41,10 @@ import org.springframework.test.context.bean.override.BeanOverride;
* Alternatively, you can explicitly specify a bean name to mock by setting the
* {@link #value() value} or {@link #name() name} attribute.
*
* <p>A new bean definition will be created if a corresponding bean definition does
* not exist. However, if you would like for the test to fail when a corresponding
* bean definition does not exist, you can set the {@link #enforceOverride()
* enforceOverride} attribute to {@code true}.
* <p>A bean will be created if a corresponding bean does not exist. However, if
* you would like for the test to fail when a corresponding bean does not exist,
* you can set the {@link #enforceOverride() enforceOverride} attribute to {@code true}
* &mdash; for example, {@code @MockitoBean(enforceOverride = true)}.
*
* <p>Dependencies that are known to the application context but are not beans
* (such as those
@@ -121,12 +121,11 @@ public @interface MockitoBean {
MockReset reset() default MockReset.AFTER;
/**
* Whether to require the existence of a bean definition for the bean being
* overridden.
* <p>Defaults to {@code false} which means that a new bean definition will
* be created if a corresponding bean definition does not exist.
* Whether to require the existence of the bean being mocked.
* <p>Defaults to {@code false} which means that a mock will be created if a
* corresponding bean does not exist.
* <p>Set to {@code true} to cause an exception to be thrown if a corresponding
* bean definition does not exist.
* bean does not exist.
* @see org.springframework.test.context.bean.override.BeanOverrideStrategy#REPLACE_OR_CREATE
* @see org.springframework.test.context.bean.override.BeanOverrideStrategy#REPLACE
*/