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.

Since:

1.0.0

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 '.').
List<PropertySource<?>>	load(String name, Resource resource) Load the resource into one or more property sources.

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 List<PropertySource<?>> load(String name,
                                    Resource resource)
                             throws IOException

Description copied from interface: PropertySourceLoader

Load the resource into one or more property sources. Implementations may either return a list containing a single source, or in the case of a multi-document format such as yaml a source for each document in the resource.

Specified by:

load in interface PropertySourceLoader

Parameters:

name - the root name of the property source. If multiple documents are loaded an additional suffix should be added to the name for each source loaded.

resource - the resource to load

Returns:

a list property sources

Throws:

IOException - if the source cannot be loaded