public class YamlPropertiesFactoryBean extends YamlProcessor implements FactoryBean<Properties>, InitializingBean
Properties
that reads from a YAML source,
exposing a flat structure of String property values.
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.
Note: All exposed values are of type String
for access through
the common Properties.getProperty(java.lang.String)
method (e.g. in configuration property
resolution through PropertiesLoaderSupport.setProperties(Properties)
).
If this is not desirable, use YamlMapFactoryBean
instead.
The Properties created by this factory have nested paths for hierarchical objects, so for instance this YAML
environments: dev: url: http://dev.bar.com name: Developer Setup prod: url: http://foo.bar.com name: My Cool Appis transformed into these properties:
environments.dev.url=http://dev.bar.com environments.dev.name=Developer Setup environments.prod.url=http://foo.bar.com environments.prod.name=My Cool AppLists are split as property keys with
[]
dereferencers, for
example this YAML:
servers: - dev.bar.com - foo.bar.combecomes properties like this:
servers[0]=dev.bar.com servers[1]=foo.bar.com
YamlProcessor.DocumentMatcher, YamlProcessor.MatchCallback, YamlProcessor.MatchStatus, YamlProcessor.ResolutionMethod, YamlProcessor.StrictMapAppenderConstructor
Constructor and Description |
---|
YamlPropertiesFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied
(and satisfied BeanFactoryAware and ApplicationContextAware).
|
protected Properties |
createProperties()
Template method that subclasses may override to construct the object
returned by this factory.
|
Properties |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setSingleton(boolean singleton)
Set if a singleton should be created, or a new object on each request
otherwise.
|
createYaml, getFlattenedMap, process, setDocumentMatchers, setMatchDefault, setResolutionMethod, setResources
public void setSingleton(boolean singleton)
true
(a singleton).public boolean isSingleton()
FactoryBean
FactoryBean.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
.
isSingleton
in interface FactoryBean<Properties>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()
public void afterPropertiesSet()
InitializingBean
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
afterPropertiesSet
in interface InitializingBean
public Properties getObject()
FactoryBean
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.
getObject
in interface FactoryBean<Properties>
null
)FactoryBeanNotInitializedException
public Class<?> getObjectType()
FactoryBean
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.
getObjectType
in interface FactoryBean<Properties>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
protected Properties createProperties()
Invoked lazily the first time getObject()
is invoked in
case of a shared singleton; else, on each getObject()
call.
()