Interface ObjectProvider<T>

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and TypeMethodDescription
      TgetIfAvailable()
      Return an instance (possibly shared or independent) of the object managed by this factory.
      default TgetIfAvailable​(Supplier<T> defaultSupplier)
      Return an instance (possibly shared or independent) of the object managed by this factory.
      TgetIfUnique()
      Return an instance (possibly shared or independent) of the object managed by this factory.
      default TgetIfUnique​(Supplier<T> defaultSupplier)
      Return an instance (possibly shared or independent) of the object managed by this factory.
      TgetObject​(Object... args)
      Return an instance (possibly shared or independent) of the object managed by this factory.
      default voidifAvailable​(Consumer<T> dependencyConsumer)
      Consume an instance (possibly shared or independent) of the object managed by this factory, if available.
      default voidifUnique​(Consumer<T> dependencyConsumer)
      Consume an instance (possibly shared or independent) of the object managed by this factory, if unique.
      default Iterator<T>iterator()
      Return an Iterator over all matching object instances, without specific ordering guarantees (but typically in registration order).
      default Stream<T>orderedStream()
      Return a sequential Stream over all matching object instances, pre-ordered according to the factory's common order comparator.
      default Stream<T>stream()
      Return a sequential Stream over all matching object instances, without specific ordering guarantees (but typically in registration order).
    • Method Detail

      • getIfAvailable

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

        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 - a callback for processing the target object if available (not called otherwise)
        Throws:
        BeansException - in case of creation errors
        Since:
        5.0
        See Also:
        getIfAvailable()
      • getIfUnique

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

        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 - a callback for processing the target object if unique (not called otherwise)
        Throws:
        BeansException - in case of creation errors
        Since:
        5.0
        See Also:
        getIfAvailable()
      • orderedStream

        default Stream<TorderedStream()
        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 Ordered conventions, and in case of annotation-based configuration also considering the Order annotation, analogous to multi-element injection points of list/array type.

        Since:
        5.1
        See Also:
        stream(), OrderComparator