Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Javadoc of ObjectProvider to clarify what is unique #34447

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −6
Open

Improve Javadoc of ObjectProvider to clarify what is unique #34447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions spring-beans/src/main/java/org/springframework/beans/factory/ObjectProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,14 @@ default void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException {
/**
* Return an instance (possibly shared or independent) of the object
* managed by this factory.
* @return an instance of the bean, or {@code null} if not available or
* not unique (i.e. multiple candidates found with none marked as primary)
* <p>An instance is considered as unique when multiple candidates found
* if it meet one of the following conditions:
* <ul>
* <li>It's the only one marked as primary</li>
* <li>It's the only one not marked as fallback</li>
* <li>It's the only one default candidate</li>
* </ul>
* @return an instance of the bean, or {@code null} if not available or not unique
* @throws BeansException in case of creation errors
* @see #getObject()
*/
Expand All @@ -167,10 +173,10 @@ default void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException {
* Return an instance (possibly shared or independent) of the object
* managed by this factory.
* @param defaultSupplier a callback for supplying a default object
* if no unique candidate is present in the factory
* if no unique (refer to {@link #getIfUnique()} for the definition)
* candidate is present in the factory
* @return an instance of the bean, or the supplied default object
* if no such bean is available or if it is not unique in the factory
* (i.e. multiple candidates found with none marked as primary)
* @throws BeansException in case of creation errors
* @since 5.0
* @see #getIfUnique()
Expand All @@ -182,12 +188,12 @@ default T getIfUnique(Supplier<T> defaultSupplier) throws BeansException {

/**
* Consume an instance (possibly shared or independent) of the object
* managed by this factory, if unique.
* managed by this factory, if unique (refer to {@link #getIfUnique()} for the definition).
* @param dependencyConsumer a callback for processing the target object
* if unique (not called otherwise)
* @throws BeansException in case of creation errors
* @since 5.0
* @see #getIfAvailable()
* @see #getIfUnique()
*/
default void ifUnique(Consumer<T> dependencyConsumer) throws BeansException {
T dependency = getIfUnique();
Expand Down