Spring Framework 6.1.4 · org.springframework.beans.factory.config.PropertiesFactoryBean

Modifier and Type	Field and Description
private boolean	singleton
private Properties	singletonInstance

Access	Constructor and Description
public	PropertiesFactoryBean()

Method Summary

Modifier and Type	Method and Description
public final void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected Properties	Returns: the object returned by this factory createProperties() Template method that subclasses may override to construct the object returned by this factory.
public final Properties	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<Properties>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public final boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public final void	setSingleton(boolean singleton) Set whether a shared 'singleton' Properties instance should be created, or rather a new Properties instance on each request.

Inherited from org.springframework.core.io.support.PropertiesLoaderSupport:: loadProperties mergeProperties setFileEncoding setIgnoreResourceNotFound setLocalOverride setLocation setLocations setProperties setPropertiesArray setPropertiesPersister

singleton	back to summary
private boolean singleton

singletonInstance	back to summary
private Properties singletonInstance Annotations @Nullable

PropertiesFactoryBean	back to summary
public PropertiesFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public final void afterPropertiesSet() throws IOException Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public final void afterPropertiesSet() throws IOException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

createProperties back to summary

createProperties	back to summary
protected Properties createProperties() throws IOException Template method that subclasses may override to construct the object returned by this factory. The default implementation returns the plain merged Properties instance. Invoked on initialization of this FactoryBean in case of a shared singleton; else, on each `getObject()` call. Returns:Properties the object returned by this factory Exceptions IOException: if an exception occurred during properties loading See Also `mergeProperties()`

protected Properties createProperties() throws IOException

Template method that subclasses may override to construct the object returned by this factory. The default implementation returns the plain merged Properties instance.

Invoked on initialization of this FactoryBean in case of a shared singleton; else, on each getObject() call.

Returns:Properties

the object returned by this factory

Exceptions

IOException:: if an exception occurred during properties loading

See Also

mergeProperties()

getObject back to summary

getObject	back to summary
public final Properties getObject() throws IOException Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern. If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:Properties an instance of the bean (can be `null`) Annotations @Override @Nullable

public final Properties getObject() throws IOException

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

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

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:Properties

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<Properties> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance. This allows one to check for specific types of beans without instantiating objects, for example on autowiring. In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too. This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available. Note Autowiring will simply ignore FactoryBeans that return `null` here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean. Returns:Class<Properties> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<Properties> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<Properties>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public final boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference. The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there. Note This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean#isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public final boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

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

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setSingleton	back to summary
public final void setSingleton(boolean singleton) Set whether a shared 'singleton' Properties instance should be created, or rather a new Properties instance on each request. Default is "true" (a shared singleton).

setSingleton

back to summary

public final void setSingleton(boolean singleton)

Set whether a shared 'singleton' Properties instance should be created, or rather a new Properties instance on each request.

Default is "true" (a shared singleton).

public Class PropertiesFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail