Top Description Fields Constructors Methods
org.springframework.beans.factory.config

public Class YamlMapFactoryBean

extends YamlProcessor
implements FactoryBean<Map<String, Object>>, InitializingBean
Class Inheritance
All Implemented Interfaces
org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.FactoryBean
Imports
java.util.LinkedHashMap, .Map, org.springframework.beans.factory.FactoryBean, .InitializingBean, org.springframework.lang.Nullable
Factory for a Map that reads from a YAML source, preserving the YAML-declared value types and their structure.

YAML is a nice human-readable format for configuration, and it has some useful hierarchical properties. It's more or less a superset of JSON, so it has a lot of similar features.

If multiple resources are provided the later ones will override entries in the earlier ones hierarchically; that is, all entries with the same nested key of type Map at any depth are merged. For example: 

foo:
  bar:
   one: two
three: four
plus (later in the list) 
foo:
  bar:
   one: 2
five: six
results in an effective input of 
foo:
  bar:
   one: 2
three: four
five: six
Note that the value of "foo" in the first document is not simply replaced with the value in the second, but its nested values are merged.

Requires SnakeYAML 2.0 or higher, as of Spring Framework 6.1.

Authors
Dave Syer, Juergen Hoeller
Since
4.1

Field Summary

Modifier and TypeField and Description
private Map<String, Object>
map

private boolean
singleton

Constructor Summary

AccessConstructor and Description
public
YamlMapFactoryBean()

Method Summary

Modifier and TypeMethod and Description
public 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 Map<String, Object>

Returns:

the object returned by this factory
createMap()

Template method that subclasses may override to construct the object returned by this factory.

public Map<String, Object>
getObject()

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

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

public Class<?>
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 boolean
isSingleton()

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

Is the object managed by this factory a singleton?

private void
merge(Map<String, Object> output, Map<String, Object> map)

public void
setSingleton(boolean singleton)

Set if a singleton should be created, or a new object on each request otherwise.

Inherited from org.springframework.beans.factory.config.YamlProcessor:
createYamlgetFlattenedMapprocesssetDocumentMatcherssetMatchDefaultsetResolutionMethodsetResourcessetSupportedTypes

Field Detail

mapback to summary
private Map<String, Object> map
Annotations
@Nullable
singletonback to summary
private boolean singleton

Constructor Detail

YamlMapFactoryBeanback to summary
public YamlMapFactoryBean()

Method Detail

afterPropertiesSetback to summary
public void afterPropertiesSet()

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
createMapback to summary
protected Map<String, Object> createMap()

Template method that subclasses may override to construct the object returned by this factory.

Invoked lazily the first time getObject() is invoked in case of a shared singleton; else, on each getObject() call.

The default implementation returns the merged Map instance.

Returns:Map<String, Object>

the object returned by this factory

See Also
process(MatchCallback)
getObjectback to summary
public Map<String, Object> getObject()

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:Map<String, Object>

an instance of the bean (can be null)

Annotations
@Override
@Nullable
getObjectTypeback to summary
public Class<?> 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<?>

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

Annotations
@Override
isSingletonback to summary
public 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
mergeback to summary
private void merge(Map<String, Object> output, Map<String, Object> map)
Annotations
@SuppressWarnings:rawtypes, unchecked
setSingletonback to summary
public void setSingleton(boolean singleton)

Set if a singleton should be created, or a new object on each request otherwise. Default is true (a singleton).