Package io.micronaut.context.env

Interface PropertySource

All Superinterfaces:

Iterable<String>, Ordered

All Known Implementing Classes:

CommandLinePropertySource, EmptyPropertySource, EnvironmentPropertySource, KubernetesEnvironmentPropertySource, MapPropertySource, SystemPropertiesPropertySource

public interface PropertySource
extends Iterable<String>, Ordered

A PropertySource is a location to resolve property values from. The property keys are available via the Iterable.iterator() method.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PropertySource.Origin	The origin of the property source.
static enum	PropertySource.PropertyConvention	Property convention.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT	The name of the property source with values supplied directly from the context.

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
Object	get(String key)	Get a property value of the given key.
default PropertySource.PropertyConvention	getConvention()
String	getName()
default @NonNull PropertySource.Origin	getOrigin()
static Map<String,Object>	mapOf(Object... values)	Create a LinkedHashMap of configuration from an array of values.
static PropertySource	of(String name, Object... values)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(String, Map, Origin)
static PropertySource	of(String name, Map<String,Object> map)	Create a PropertySource from the given map.
static PropertySource	of(String name, Map<String,Object> map, int priority)	Create a PropertySource from the given map.
static PropertySource	of(String name, Map<String,Object> map, PropertySource.Origin origin)	Create a PropertySource from the given map.
static PropertySource	of(String name, Map<String,Object> map, PropertySource.Origin origin, int priority)	Create a PropertySource from the given map.
static PropertySource	of(String name, Map<String,Object> map, PropertySource.PropertyConvention convention)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(String, Map, PropertyConvention, Origin)
static PropertySource	of(String name, Map<String,Object> map, PropertySource.PropertyConvention convention, PropertySource.Origin origin)	Create a PropertySource from the given map.
static PropertySource	of(Map<String,Object> map)	Create a PropertySource named Environment.DEFAULT_NAME from the given map.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

getOrder

Field Details

CONTEXT

static final String CONTEXT

The name of the property source with values supplied directly from the context.

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns:

The name of the property source

get

Object get(String key)

Get a property value of the given key.

Parameters:

key - The key

Returns:

The value

getOrigin

@NonNull
default @NonNull PropertySource.Origin getOrigin()

Returns:

The origin of the property source.

Since:

4.8.0

getConvention

default PropertySource.PropertyConvention getConvention()

Returns:

Whether the property source has upper case underscore separated keys

of

static PropertySource of(String name,
 Map<String,Object> map)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

map - The map

Returns:

The PropertySource

of

static PropertySource of(String name,
 Map<String,Object> map,
 PropertySource.Origin origin)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

map - The map

origin - The origin

Returns:

The PropertySource

of

@Deprecated(forRemoval=true,
            since="4.8.0")
static PropertySource of(String name,
 Map<String,Object> map,
 PropertySource.PropertyConvention convention)

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

Use of(String, Map, PropertyConvention, Origin)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

map - The map

convention - The convention type of the property source

Returns:

The PropertySource

of

static PropertySource of(String name,
 Map<String,Object> map,
 PropertySource.PropertyConvention convention,
 PropertySource.Origin origin)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

map - The map

convention - The convention type of the property source

origin - The origin

Returns:

The PropertySource

of

@Deprecated(forRemoval=true)
static PropertySource of(String name,
 Object... values)

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

Use of(String, Map, Origin)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

values - The values as an array of alternating key/value entries

Returns:

The PropertySource

Since:

2.0

mapOf

static Map<String,Object> mapOf(Object... values)

Create a LinkedHashMap of configuration from an array of values.

Parameters:

values - The values

Returns:

The created map

Since:

2.0

of

static PropertySource of(String name,
 Map<String,Object> map,
 int priority)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

map - The map

priority - The priority to order by

Returns:

The PropertySource

of

static PropertySource of(String name,
 Map<String,Object> map,
 PropertySource.Origin origin,
 int priority)

Create a PropertySource from the given map.

Parameters:

name - The name of the property source

map - The map

origin - The origin

priority - The priority to order by

Returns:

The PropertySource

Since:

4.8.0

of

static PropertySource of(Map<String,Object> map)

Create a PropertySource named Environment.DEFAULT_NAME from the given map.

Parameters:

map - The map

Returns:

The PropertySource