io.micronaut.context.env

Interface PropertySourceLoader

All Superinterfaces:

PropertySourceLocator, PropertySourceReader, Toggleable

All Known Implementing Classes:

AbstractPropertySourceLoader, EnvJsonPropertySourceLoader, JsonPropertySourceLoader, PropertiesPropertySourceLoader, YamlPropertySourceLoader

public interface PropertySourceLoader
extends Toggleable, PropertySourceLocator, PropertySourceReader

Loads the given property source for the given environment.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
default Optional<PropertySource>	load(Environment environment) Load a PropertySource for the given Environment.
default Optional<PropertySource>	load(String resourceName, ResourceLoader resourceLoader) Load a PropertySource for the given Environment.
Optional<PropertySource>	load(String resourceName, ResourceLoader resourceLoader, String environmentName) Deprecated. Use load(String, ResourceLoader) or loadEnv(String, ResourceLoader, ActiveEnvironment) (String, ResourceLoader, ActiveEnvironment)} instead
default Optional<PropertySource>	loadEnv(String resourceName, ResourceLoader resourceLoader, ActiveEnvironment activeEnvironment) Load a PropertySource for the given Environment.

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Methods inherited from interface io.micronaut.context.env.PropertySourceReader

getExtensions, read, read

Method Detail

load

default Optional<PropertySource> load(Environment environment)

Load a PropertySource for the given Environment.

Specified by:

load in interface PropertySourceLocator

Parameters:

environment - The environment

Returns:

An optional of PropertySource

load

default Optional<PropertySource> load(String resourceName,
                                      ResourceLoader resourceLoader)

Load a PropertySource for the given Environment.

Parameters:

resourceName - The resourceName of the resource to load

resourceLoader - The ResourceLoader to retrieve the resource

Returns:

An optional of PropertySource

load

@Deprecated
Optional<PropertySource> load(String resourceName,
                                          ResourceLoader resourceLoader,
                                          @Nullable
                                          String environmentName)

Deprecated. Use load(String, ResourceLoader) or loadEnv(String, ResourceLoader, ActiveEnvironment) (String, ResourceLoader, ActiveEnvironment)} instead

Load a PropertySource for the given Environment.

Parameters:

resourceName - The resourceName of the resource to load

resourceLoader - The ResourceLoader to retrieve the resource

environmentName - The environment name to load. Null if the default environment is to be used

Returns:

An optional of PropertySource

loadEnv

default Optional<PropertySource> loadEnv(String resourceName,
                                         ResourceLoader resourceLoader,
                                         ActiveEnvironment activeEnvironment)

Load a PropertySource for the given Environment.

Parameters:

resourceName - The resourceName of the resource to load

resourceLoader - The ResourceLoader to retrieve the resource

activeEnvironment - The environment to load

Returns:

An optional of PropertySource