Interface SmartFactoryBean<T>

Type Parameters:
T - the bean type
All Superinterfaces:
FactoryBean<T>
All Known Implementing Classes:
AbstractEntityManagerFactoryBean, LocalContainerEntityManagerFactoryBean, LocalEntityManagerFactoryBean
public interface SmartFactoryBean<T> extends FactoryBean<T>
Extension of the FactoryBean interface. Implementations may indicate whether they always return independent instances, for the case where their FactoryBean.isSingleton() implementation returning false does not clearly indicate independent instances. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if their FactoryBean.isSingleton() implementation returns false; the exposed object is only accessed on demand.

As of 7.0, this interface also allows for exposing additional object types for dependency injection through implementing a pair of methods: getObject(Class) as well as supportsType(Class). The primary FactoryBean.getObjectType() will be exposed for regular access. Only if a specific type is requested, additional types are considered.

NOTE: This interface is a special purpose interface, mainly for internal use within the framework and within collaborating frameworks. In general, application-provided FactoryBeans should simply implement the plain FactoryBean interface. New methods might be added to this extended interface even in point releases.

Since:
2.0.3
Author:
Juergen Hoeller
See Also:

  • Field Summary

    Fields inherited from interface org.springframework.beans.factory.FactoryBean

    OBJECT_TYPE_ATTRIBUTE

  • Method Summary

    Modifier and Type
    Method
    Description
    default <S> @Nullable S
    getObject(Class<S> type)
    Return an instance of the given type, if supported by this factory.
    default boolean
    isEagerInit()
    Does this FactoryBean expect eager initialization, that is, eagerly initialize itself as well as expect eager initialization of its singleton object (if any)?
    default boolean
    isPrototype()
    Is the object managed by this factory a prototype? That is, will FactoryBean.getObject() always return an independent instance?
    default boolean
    supportsType(Class<?> type)
    Determine whether this factory supports the requested type.

    Methods inherited from interface org.springframework.beans.factory.FactoryBean

    getObject, getObjectType, isSingleton

  • Method Details

    • getObject

      default <S> @Nullable S getObject(Class<S> type) throws Exception
      Return an instance of the given type, if supported by this factory.

      By default, this supports the primary type exposed by the factory, as indicated by FactoryBean.getObjectType() and returned by FactoryBean.getObject(). Specific factories may support additional types for dependency injection.

      Parameters:
      type - the requested type
      Returns:
      a corresponding instance managed by this factory, or null if none available
      Throws:
      Exception - in case of creation errors
      Since:
      7.0
      See Also:

    • supportsType

      default boolean supportsType(Class<?> type)
      Determine whether this factory supports the requested type.

      By default, this supports the primary type exposed by the factory, as indicated by FactoryBean.getObjectType(). Specific factories may support additional types for dependency injection.

      Parameters:
      type - the requested type
      Returns:
      true if getObject(Class) is able to return a corresponding instance, false otherwise
      Since:
      7.0
      See Also:

    • isPrototype

      default boolean isPrototype()
      Is the object managed by this factory a prototype? That is, will FactoryBean.getObject() always return an independent instance?

      The prototype status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

      This method is supposed to strictly check for independent instances; it should not return true for scoped objects or other kinds of non-singleton, non-independent objects. For this reason, this is not simply the inverted form of FactoryBean.isSingleton().

      The default implementation returns false.

      Returns:
      whether the exposed object is a prototype
      See Also:

    • isEagerInit

      default boolean isEagerInit()
      Does this FactoryBean expect eager initialization, that is, eagerly initialize itself as well as expect eager initialization of its singleton object (if any)?

      A standard FactoryBean is not expected to initialize eagerly: Its FactoryBean.getObject() will only be called for actual access, even in case of a singleton object. Returning true from this method suggests that FactoryBean.getObject() should be called eagerly, also applying post-processors eagerly. This may make sense in case of a singleton object, in particular if post-processors expect to be applied on startup.

      The default implementation returns false.

      Returns:
      whether eager initialization applies
      See Also: