org.springframework.boot.bind

Class YamlConfigurationFactory<T>

java.lang.Object

org.springframework.boot.bind.YamlConfigurationFactory<T>

Type Parameters:

T - the configuration type

All Implemented Interfaces:

Aware, FactoryBean<T>, InitializingBean, MessageSourceAware

public class YamlConfigurationFactory<T>
extends Object
implements FactoryBean<T>, MessageSourceAware, InitializingBean

Validate some YAML by binding it to an object of a specified type and then optionally running a Validator over it.

Author:

Luke Taylor, Dave Syer

Constructor Summary

Constructors

Constructor and Description
YamlConfigurationFactory(Class<?> type) Sets a validation constructor which will be applied to the YAML doc to see whether it matches the expected JavaBean.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
T	getObject()
Class<?>	getObjectType()
boolean	isSingleton()
void	setExceptionIfInvalid(boolean exceptionIfInvalid) Deprecated. as of 1.5, do not specify a Validator if validation should not occur
void	setMessageSource(MessageSource messageSource) Set the message source.
void	setPropertyAliases(Map<Class<?>,Map<String,String>> propertyAliases) Set the property aliases.
void	setResource(Resource resource) Set the resource.
void	setValidator(Validator validator) Set the validator.
void	setYaml(String yaml) Set the YAML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YamlConfigurationFactory

public YamlConfigurationFactory(Class<?> type)

Sets a validation constructor which will be applied to the YAML doc to see whether it matches the expected JavaBean.

Parameters:

type - the root type

Method Detail

setMessageSource

public void setMessageSource(MessageSource messageSource)

Set the message source.

Specified by:

setMessageSource in interface MessageSourceAware

Parameters:

messageSource - the message source

setPropertyAliases

public void setPropertyAliases(Map<Class<?>,Map<String,String>> propertyAliases)

Set the property aliases.

Parameters:

propertyAliases - the property aliases

setYaml

public void setYaml(String yaml)

Set the YAML.

Parameters:

yaml - the YAML

setResource

public void setResource(Resource resource)

Set the resource.

Parameters:

resource - the resource

setValidator

public void setValidator(Validator validator)

Set the validator.

Parameters:

validator - the validator

setExceptionIfInvalid

@Deprecated
public void setExceptionIfInvalid(boolean exceptionIfInvalid)

Deprecated. as of 1.5, do not specify a Validator if validation should not occur

Set a flag to indicate that an exception should be raised if a Validator is available and validation fails.

Parameters:

exceptionIfInvalid - the flag to set

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<T>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface FactoryBean<T>

getObject

public T getObject()
            throws Exception

Specified by:

getObject in interface FactoryBean<T>

Throws:

Exception