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 java.lang.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 and Description
static int	DEFAULT_POSITION Default position for the property source loader.

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractPropertySourceLoader()

Method Summary

Modifier and Type	Method and Description
protected MapPropertySource	createPropertySource(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> map, int order)
int	getOrder()
java.util.Optional<PropertySource>	load(java.lang.String resourceName, ResourceLoader resourceLoader) Load a PropertySource for the given Environment.
java.util.Optional<PropertySource>	loadEnv(java.lang.String resourceName, ResourceLoader resourceLoader, ActiveEnvironment activeEnvironment) Load a PropertySource for the given Environment.
protected abstract void	processInput(java.lang.String name, java.io.InputStream input, java.util.Map<java.lang.String,java.lang.Object> finalMap)
protected void	processMap(java.util.Map<java.lang.String,java.lang.Object> finalMap, java.util.Map map, java.lang.String prefix)
java.util.Map<java.lang.String,java.lang.Object>	read(java.lang.String name, java.io.InputStream input) Read a property source from an input stream.
protected java.util.Optional<java.io.InputStream>	readInput(ResourceLoader resourceLoader, java.lang.String fileName)

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.core.util.Toggleable

isEnabled

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

getExtensions, read

Field Detail

DEFAULT_POSITION

public static final int DEFAULT_POSITION

Default position for the property source loader.

See Also:

Constant Field Values

Constructor Detail

AbstractPropertySourceLoader

public AbstractPropertySourceLoader()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

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

load

public java.util.Optional<PropertySource> load(java.lang.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 java.util.Optional<PropertySource> loadEnv(java.lang.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(java.lang.String name,
                                                 java.util.Map<java.lang.String,java.lang.Object> map,
                                                 int order)

Parameters:

name - The name of the property source

map - The map

order - The order of the property source

Returns:

property source

read

public java.util.Map<java.lang.String,java.lang.Object> read(java.lang.String name,
                                                             java.io.InputStream input)
                                                      throws java.io.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:

java.io.IOException - if there is an error processing the property source

readInput

protected java.util.Optional<java.io.InputStream> readInput(ResourceLoader resourceLoader,
                                                            java.lang.String fileName)

Parameters:

resourceLoader - The resource loader

fileName - The file name

Returns:

An input stream wrapped inside an Optional

processInput

protected abstract void processInput(java.lang.String name,
                                     java.io.InputStream input,
                                     java.util.Map<java.lang.String,java.lang.Object> finalMap)
                              throws java.io.IOException

Parameters:

name - The name

input - The input stream

finalMap - The map with all the properties processed

Throws:

java.io.IOException - If the input stream doesn't exist

processMap

protected void processMap(java.util.Map<java.lang.String,java.lang.Object> finalMap,
                          java.util.Map map,
                          java.lang.String prefix)

Parameters:

finalMap - The map with all the properties processed

map - The map to process

prefix - The prefix for the keys