io.micronaut.context.env

Interface PropertySource

All Superinterfaces:

java.lang.Iterable<java.lang.String>, Ordered

All Known Implementing Classes:

CommandLinePropertySource, EmptyPropertySource, EnvironmentPropertySource, KubernetesEnvironmentPropertySource, MapPropertySource, SystemPropertiesPropertySource

public interface PropertySource
extends java.lang.Iterable<java.lang.String>, Ordered

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

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PropertySource.PropertyConvention Property convention.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.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 and Description
java.lang.Object	get(java.lang.String key) Get a property value of the given key.
default PropertySource.PropertyConvention	getConvention()
java.lang.String	getName()
static java.util.Map<java.lang.String,java.lang.Object>	mapOf(java.lang.Object... values) Create a LinkedHashMap of configuration from an array of values.
static PropertySource	of(java.util.Map<java.lang.String,java.lang.Object> map) Create a PropertySource named Environment.DEFAULT_NAME from the given map.
static PropertySource	of(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> map) Create a PropertySource from the given map.
static PropertySource	of(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> map, int priority) Create a PropertySource from the given map.
static PropertySource	of(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> map, PropertySource.PropertyConvention convention) Create a PropertySource from the given map.
static PropertySource	of(java.lang.String name, java.lang.Object... values) Create a PropertySource 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 Detail

CONTEXT

static final java.lang.String CONTEXT

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

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns:

The name of the property source

get

java.lang.Object get(java.lang.String key)

Get a property value of the given key.

Parameters:

key - The key

Returns:

The value

getConvention

default PropertySource.PropertyConvention getConvention()

Returns:

Whether the property source has upper case under score separated keys

of

static PropertySource of(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.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(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.Object> map,
                         PropertySource.PropertyConvention convention)

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(java.lang.String name,
                         java.lang.Object... values)

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 java.util.Map<java.lang.String,java.lang.Object> mapOf(java.lang.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(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> map)

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

Parameters:

map - The map

Returns:

The PropertySource