Spring Framework 6.1.4 · org.springframework.beans.factory.ObjectProvider

Method Summary

Modifier and Type	Method and Description
public T	Returns: an instance of the bean, or `null` if not available getIfAvailable() Return an instance (possibly shared or independent) of the object managed by this factory.
public default T	Returns: an instance of the bean, or the supplied default object if no such bean is available getIfAvailable(Supplier<T> a callback for supplying a default object if none is present in the factory defaultSupplier) Return an instance (possibly shared or independent) of the object managed by this factory.
public T	Returns: an instance of the bean, or `null` if not available or not unique (i.e. multiple candidates found with none marked as primary) getIfUnique() Return an instance (possibly shared or independent) of the object managed by this factory.
public default T	Returns: 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) getIfUnique(Supplier<T> a callback for supplying a default object if no unique candidate is present in the factory defaultSupplier) Return an instance (possibly shared or independent) of the object managed by this factory.
public T	Returns: an instance of the bean getObject(Object... arguments to use when creating a corresponding instance args) Return an instance (possibly shared or independent) of the object managed by this factory.
public default void	ifAvailable(Consumer<T> a callback for processing the target object if available (not called otherwise) dependencyConsumer) Consume an instance (possibly shared or independent) of the object managed by this factory, if available.
public default void	ifUnique(Consumer<T> a callback for processing the target object if unique (not called otherwise) dependencyConsumer) Consume an instance (possibly shared or independent) of the object managed by this factory, if unique.
public default Iterator<T>	iterator() Implements java.lang.Iterable.iterator. Return an `Iterator` over all matching object instances, without specific ordering guarantees (but typically in registration order).
public default Stream<T>	orderedStream() Return a sequential `Stream` over all matching object instances, pre-ordered according to the factory's common order comparator.
public default Stream<T>	stream() Return a sequential `Stream` over all matching object instances, without specific ordering guarantees (but typically in registration order).

Inherited from java.lang.Iterable:: forEach spliterator
Inherited from org.springframework.beans.factory.ObjectFactory:: getObject

Method Detail

getIfAvailable back to summary

getIfAvailable	back to summary
public T getIfAvailable() throws BeansException Return an instance (possibly shared or independent) of the object managed by this factory. Returns:T an instance of the bean, or `null` if not available Annotations @Nullable Exceptions BeansException: in case of creation errors See Also `getObject()`

public T getIfAvailable() throws BeansException

Return an instance (possibly shared or independent) of the object managed by this factory.

Returns:T

an instance of the bean, or null if not available

Annotations

@Nullable

Exceptions

BeansException:: in case of creation errors

See Also

getObject()

getIfAvailable back to summary

getIfAvailable	back to summary
public default T getIfAvailable(Supplier<T> defaultSupplier) throws BeansException Return an instance (possibly shared or independent) of the object managed by this factory. Parameters defaultSupplier:Supplier<T> a callback for supplying a default object if none is present in the factory Returns:T an instance of the bean, or the supplied default object if no such bean is available Exceptions BeansException: in case of creation errors Since 5.0 See Also `getIfAvailable()`

public default T getIfAvailable(Supplier<T> defaultSupplier) throws BeansException

Return an instance (possibly shared or independent) of the object managed by this factory.

Parameters

defaultSupplier:Supplier<T>: a callback for supplying a default object if none is present in the factory

Returns:T

an instance of the bean, or the supplied default object if no such bean is available

Exceptions

BeansException:: in case of creation errors

Since

5.0

See Also

getIfAvailable()

getIfUnique back to summary

getIfUnique	back to summary
public T getIfUnique() throws BeansException Return an instance (possibly shared or independent) of the object managed by this factory. Returns:T an instance of the bean, or `null` if not available or not unique (i.e. multiple candidates found with none marked as primary) Annotations @Nullable Exceptions BeansException: in case of creation errors See Also `getObject()`

public T getIfUnique() throws BeansException

Return an instance (possibly shared or independent) of the object managed by this factory.

Returns:T

an instance of the bean, or null if not available or not unique (i.e. multiple candidates found with none marked as primary)

Annotations

@Nullable

Exceptions

BeansException:: in case of creation errors

See Also

getObject()

getIfUnique back to summary

getIfUnique	back to summary
public default T getIfUnique(Supplier<T> defaultSupplier) throws BeansException Return an instance (possibly shared or independent) of the object managed by this factory. Parameters defaultSupplier:Supplier<T> a callback for supplying a default object if no unique candidate is present in the factory Returns:T 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) Exceptions BeansException: in case of creation errors Since 5.0 See Also `getIfUnique()`

public default T getIfUnique(Supplier<T> defaultSupplier) throws BeansException

Return an instance (possibly shared or independent) of the object managed by this factory.

Parameters

defaultSupplier:Supplier<T>: a callback for supplying a default object if no unique candidate is present in the factory

Returns:T

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)

Exceptions

BeansException:: in case of creation errors

Since

5.0

See Also

getIfUnique()

getObject back to summary

getObject	back to summary
public T getObject(Object... args) throws BeansException Return an instance (possibly shared or independent) of the object managed by this factory. Allows for specifying explicit construction arguments, along the lines of `BeanFactory#getBean(String, Object...)`. Parameters args:Object[] arguments to use when creating a corresponding instance Returns:T an instance of the bean Exceptions BeansException: in case of creation errors See Also `getObject()`

public T getObject(Object... args) throws BeansException

Return an instance (possibly shared or independent) of the object managed by this factory.

Allows for specifying explicit construction arguments, along the lines of BeanFactory#getBean(String, Object...).

Parameters

args:Object[]: arguments to use when creating a corresponding instance

Returns:T

an instance of the bean

Exceptions

BeansException:: in case of creation errors

See Also

getObject()

ifAvailable back to summary

ifAvailable	back to summary
public default void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException Consume an instance (possibly shared or independent) of the object managed by this factory, if available. Parameters dependencyConsumer:Consumer<T> a callback for processing the target object if available (not called otherwise) Exceptions BeansException: in case of creation errors Since 5.0 See Also `getIfAvailable()`

public default void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException

Consume an instance (possibly shared or independent) of the object managed by this factory, if available.

Parameters

dependencyConsumer:Consumer<T>: a callback for processing the target object if available (not called otherwise)

Exceptions

BeansException:: in case of creation errors

Since

5.0

See Also

getIfAvailable()

ifUnique back to summary

ifUnique	back to summary
public default void ifUnique(Consumer<T> dependencyConsumer) throws BeansException Consume an instance (possibly shared or independent) of the object managed by this factory, if unique. Parameters dependencyConsumer:Consumer<T> a callback for processing the target object if unique (not called otherwise) Exceptions BeansException: in case of creation errors Since 5.0 See Also `getIfAvailable()`

public default void ifUnique(Consumer<T> dependencyConsumer) throws BeansException

Consume an instance (possibly shared or independent) of the object managed by this factory, if unique.

Parameters

dependencyConsumer:Consumer<T>: a callback for processing the target object if unique (not called otherwise)

Exceptions

BeansException:: in case of creation errors

Since

5.0

See Also

getIfAvailable()

iterator back to summary

iterator	back to summary
public default Iterator<T> iterator() Implements java.lang.Iterable.iterator. Return an `Iterator` over all matching object instances, without specific ordering guarantees (but typically in registration order). Returns:Iterator<T> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override Since 5.1 See Also `stream()`

public default Iterator<T> iterator()

Implements java.lang.Iterable.iterator.

Return an Iterator over all matching object instances, without specific ordering guarantees (but typically in registration order).

Returns:Iterator<T>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

Since

5.1

See Also

stream()

orderedStream back to summary

orderedStream	back to summary
public default Stream<T> orderedStream() Return a sequential `Stream` over all matching object instances, pre-ordered according to the factory's common order comparator. In a standard Spring application context, this will be ordered according to `org.springframework.core.Ordered` conventions, and in case of annotation-based configuration also considering the `org.springframework.core.annotation.Order` annotation, analogous to multi-element injection points of list/array type. Since 5.1 See Also `stream()`, `org.springframework.core.OrderComparator`

public default Stream<T> orderedStream()

Return a sequential Stream over all matching object instances, pre-ordered according to the factory's common order comparator.

In a standard Spring application context, this will be ordered according to org.springframework.core.Ordered conventions, and in case of annotation-based configuration also considering the org.springframework.core.annotation.Order annotation, analogous to multi-element injection points of list/array type.

Since: 5.1
See Also: stream(), org.springframework.core.OrderComparator

stream back to summary

stream	back to summary
public default Stream<T> stream() Return a sequential `Stream` over all matching object instances, without specific ordering guarantees (but typically in registration order). Since 5.1 See Also `iterator()`, `orderedStream()`

public default Stream<T> stream()

Return a sequential Stream over all matching object instances, without specific ordering guarantees (but typically in registration order).

Since: 5.1
See Also: iterator(), orderedStream()

public Interface ObjectProvider<T>

Method Summary

Method Detail