org.springframework.boot.context.config

Interface ConfigDataLoader<R extends ConfigDataResource>

Type Parameters:

R - the resource type

All Known Implementing Classes:

ConfigTreeConfigDataLoader, StandardConfigDataLoader

public interface ConfigDataLoader<R extends ConfigDataResource>

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

• Log or DeferredLogFactory - if the loader 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 resource.

Since:

2.4.0

Method Summary

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

Method Detail

isLoadable

default boolean isLoadable(ConfigDataLoaderContext context,
                           R resource)

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

Parameters:

context - the loader context

resource - the resource to check.

Returns:

if the resource is supported by this loader

load

ConfigData load(ConfigDataLoaderContext context,
                R resource)
         throws java.io.IOException,
                ConfigDataResourceNotFoundException

Load ConfigData for the given resource.

Parameters:

context - the loader context

resource - the resource to load

Returns:

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

Throws:

java.io.IOException - on IO error

ConfigDataResourceNotFoundException - if the resource cannot be found