PropertySourceLoader Type — spring-boot Architecture

Source Code

core/spring-boot/src/main/java/org/springframework/boot/env/PropertySourceLoader.java lines 37–74

public interface PropertySourceLoader {

	/**
	 * Returns the file extensions that the loader supports (excluding the '.').
	 * @return the file extensions
	 */
	String[] getFileExtensions();

	/**
	 * 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.
	 * @param 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.
	 * @param resource the resource to load
	 * @return a list property sources
	 * @throws IOException if the source cannot be loaded
	 */
	List<PropertySource<?>> load(String name, Resource resource) throws IOException;

	/**
	 * 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.
	 * @param 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.
	 * @param resource the resource to load
	 * @param encoding encoding of the resource
	 * @return a list property sources
	 * @throws IOException if the source cannot be loaded
	 * @since 4.1.0
	 */
	default List<PropertySource<?>> load(String name, Resource resource, @Nullable Charset encoding)
			throws IOException {
		return load(name, resource);
	}

}