org.springframework.boot.context.config

Interface ConfigDataLoader<L extends ConfigDataLocation>

Type Parameters:

L - the location type

public interface ConfigDataLoader<L extends ConfigDataLocation>

Strategy class that can be used used to load ConfigData instances from a location. Implementations should be added as a spring.factories entries. The following constructor parameter types are supported:

• Log - if the resolver needs deferred logging
• ConfigurableBootstrapContext - A bootstrap context that can be used to store objects that may be expensive to create, or need to be shared (BootstrapContext or BootstrapRegistry may also be used).

Multiple loaders cannot claim the same location.

Since:

2.4.0

Author:

Phillip Webb, Madhura Bhave

Method Summary

Modifier and Type	Method and Description
default boolean	isLoadable(ConfigDataLoaderContext context, L location) Returns if the specified location can be loaded by this instance.
ConfigData	load(ConfigDataLoaderContext context, L location) Load ConfigData for the given location.

Method Detail

isLoadable

default boolean isLoadable(ConfigDataLoaderContext context,
                           L location)

Returns if the specified location can be loaded by this instance.

Parameters:

context - the loader context

location - the location to check.

Returns:

if the location is supported by this loader

load

ConfigData load(ConfigDataLoaderContext context,
                L location)
         throws IOException,
                ConfigDataLocationNotFoundException

Load ConfigData for the given location.

Parameters:

context - the loader context

location - the location to load

Returns:

the loaded config data or null if the location should be skipped

Throws:

IOException - on IO error

ConfigDataLocationNotFoundException - if the location cannot be found