Class EnvironmentPropertySource

java.lang.Object

io.micronaut.context.env.MapPropertySource

io.micronaut.context.env.EnvironmentPropertySource

All Implemented Interfaces:

PropertySource, Ordered, Iterable<String>

public class EnvironmentPropertySource
extends MapPropertySource

Loads properties from environment variables via System.getenv().

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from interface PropertySource

PropertySource.Origin, PropertySource.PropertyConvention

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Constant for Environment property source.
static final PropertySource.Origin	ORIGIN
static final int	POSITION	The position of the loader.

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface PropertySource

CONTEXT

Constructor Summary

Constructors

Constructor	Description
EnvironmentPropertySource()	Default constructor.
EnvironmentPropertySource(@Nullable List<String> includes, @Nullable List<String> excludes)	Allows for control over which environment variables are included.

Method Summary

Modifier and Type	Method	Description
PropertySource.PropertyConvention	getConvention()
int	getOrder()
PropertySource.Origin	getOrigin()

Methods inherited from class MapPropertySource

asMap, get, getName, iterator, of, toString

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Details

POSITION

public static final int POSITION

The position of the loader.

See Also:

• Constant Field Values

NAME

public static final String NAME

Constant for Environment property source.

See Also:

• Constant Field Values

ORIGIN

public static final PropertySource.Origin ORIGIN

Constructor Details

EnvironmentPropertySource

public EnvironmentPropertySource()

Default constructor.

EnvironmentPropertySource

public EnvironmentPropertySource(@Nullable List<String> includes,
 @Nullable List<String> excludes)

Allows for control over which environment variables are included.

Parameters:

includes - The environment variables to include in configuration

excludes - The environment variables to exclude from configuration

Method Details

getOrder

public int getOrder()

Returns:

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

getOrigin

public PropertySource.Origin getOrigin()

Returns:

The origin of the property source.

getConvention

public PropertySource.PropertyConvention getConvention()

Returns:

Whether the property source has upper case underscore separated keys