Package io.micronaut.context.env

Class AbstractPropertySourceLoader

java.lang.Object

io.micronaut.context.env.AbstractPropertySourceLoader

All Implemented Interfaces:

PropertySourceLoader, PropertySourceLocator, PropertySourceReader, Ordered, Toggleable

Direct Known Subclasses:

JsonPropertySourceLoader, JsonPropertySourceLoader, PropertiesPropertySourceLoader, YamlPropertySourceLoader

public abstract class AbstractPropertySourceLoader
extends Object
implements PropertySourceLoader, Toggleable, Ordered

An abstract implementation of the PropertySourceLoader interface.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_POSITION	Default position for the property source loader.
protected org.slf4j.Logger	log

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPropertySourceLoader()
protected	AbstractPropertySourceLoader(boolean logEnabled)

Method Summary

Modifier and Type	Method	Description
protected MapPropertySource	createPropertySource(String name, Map<String,Object> map, int order)	Deprecated, for removal: This API element is subject to removal in a future version. Use createPropertySource(String, Map, int, PropertySource.Origin)
protected MapPropertySource	createPropertySource(String name, Map<String,Object> map, int order, PropertySource.Origin origin)
int	getOrder()
boolean	isLogEnabled()	Deprecated. don't need to have this method
Optional<PropertySource>	load(String resourceName, ResourceLoader resourceLoader)	Load a PropertySource for the given Environment.
Optional<PropertySource>	loadEnv(String resourceName, ResourceLoader resourceLoader, ActiveEnvironment activeEnvironment)	Load a PropertySource for the given Environment.
protected abstract void	processInput(String name, InputStream input, Map<String,Object> finalMap)
protected void	processMap(Map<String,Object> finalMap, Map map, String prefix)
Map<String,Object>	read(String name, InputStream input)	Read a property source from an input stream.
protected Optional<InputStream>	readInput(ResourceLoader resourceLoader, String fileName)
void	setLogEnabled(boolean logEnabled)	Deprecated. set logEnabled value by constructor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

load

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

getExtensions, read

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

isEnabled

Field Details

DEFAULT_POSITION

public static final int DEFAULT_POSITION

Default position for the property source loader.

See Also:

• Constant Field Values

log

protected org.slf4j.Logger log

Constructor Details

AbstractPropertySourceLoader

protected AbstractPropertySourceLoader()

AbstractPropertySourceLoader

protected AbstractPropertySourceLoader(boolean logEnabled)

Method Details

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).

load

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

Description copied from interface: PropertySourceLoader

Load a PropertySource for the given Environment.

Specified by:

load in interface PropertySourceLoader

Parameters:

resourceName - The resourceName of the resource to load

resourceLoader - The ResourceLoader to retrieve the resource

Returns:

An optional of PropertySource

loadEnv

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

Description copied from interface: PropertySourceLoader

Load a PropertySource for the given Environment.

Specified by:

loadEnv in interface PropertySourceLoader

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

createPropertySource

protected MapPropertySource createPropertySource(String name,
 Map<String,Object> map,
 int order,
 PropertySource.Origin origin)

Parameters:

name - The name of the property source

map - The map

order - The order of the property source

Returns:

property source

createPropertySource

@Deprecated(forRemoval=true)
protected MapPropertySource createPropertySource(String name,
 Map<String,Object> map,
 int order)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createPropertySource(String, Map, int, PropertySource.Origin)

Parameters:

name - The name of the property source

map - The map

order - The order of the property source

Returns:

property source

read

public Map<String,Object> read(String name,
 InputStream input)
                        throws IOException

Description copied from interface: PropertySourceReader

Read a property source from an input stream.

Specified by:

read in interface PropertySourceReader

Parameters:

name - The name of the property source

input - The bytes

Returns:

A map of string to values

Throws:

IOException - if there is an error processing the property source

readInput

protected Optional<InputStream> readInput(ResourceLoader resourceLoader,
 String fileName)

Parameters:

resourceLoader - The resource loader

fileName - The file name

Returns:

An input stream wrapped inside an Optional

processInput

protected abstract void processInput(String name,
 InputStream input,
 Map<String,Object> finalMap)
                              throws IOException

Parameters:

name - The name

input - The input stream

finalMap - The map with all the properties processed

Throws:

IOException - If the input stream doesn't exist

processMap

protected void processMap(Map<String,Object> finalMap,
 Map map,
 String prefix)

Parameters:

finalMap - The map with all the properties processed

map - The map to process

prefix - The prefix for the keys

isLogEnabled

@Deprecated
public boolean isLogEnabled()

Deprecated.

don't need to have this method

Return logEnabled value.

Returns:

is log enabled

Since:

3.9.0

setLogEnabled

@Deprecated
public void setLogEnabled(boolean logEnabled)

Deprecated.

set logEnabled value by constructor

Setter for logEnabled.

Parameters:

logEnabled - is log enabled

Since:

3.9.0