org.springframework.boot.env

Class YamlPropertySourceLoader

java.lang.Object

org.springframework.boot.env.YamlPropertySourceLoader

All Implemented Interfaces:

PropertySourceLoader

public class YamlPropertySourceLoader
extends Object
implements PropertySourceLoader

Strategy to load '.yml' (or '.yaml') files into a PropertySource.

Author:

Dave Syer, Phillip Webb, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
YamlPropertySourceLoader()

Method Summary

Modifier and Type	Method and Description
String[]	getFileExtensions() Returns the file extensions that the loader supports (excluding the '.').
PropertySource<?>	load(String name, Resource resource, String profile) Load the resource into a property source.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlPropertySourceLoader

public YamlPropertySourceLoader()

Method Detail

getFileExtensions

public String[] getFileExtensions()

Description copied from interface: PropertySourceLoader

Returns the file extensions that the loader supports (excluding the '.').

Specified by:

getFileExtensions in interface PropertySourceLoader

Returns:

the file extensions

load

public PropertySource<?> load(String name,
                              Resource resource,
                              String profile)
                       throws IOException

Description copied from interface: PropertySourceLoader

Load the resource into a property source.

Specified by:

load in interface PropertySourceLoader

Parameters:

name - the name of the property source

resource - the resource to load

profile - the name of the profile to load or null. The profile can be used to load multi-document files (such as YAML). Simple property formats should null when asked to load a profile.

Returns:

a property source or null

Throws:

IOException - if the source cannot be loaded