Package io.micronaut.context.env

Interface ConfigurationPath

All Superinterfaces:

Iterable<ConfigurationPath.ConfigurationSegment>

public sealed interface ConfigurationPath
extends Iterable<ConfigurationPath.ConfigurationSegment>

Models a configuration path such as those declared within ConfigurationProperties and EachProperty declarations.

Since:

4.0.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConfigurationPath.ConfigurationSegment	A segment of configuration.

Method Summary

Modifier and Type	Method	Description
default <T> @Nullable Qualifier<T>	beanQualifier()
@Nullable Class<?>	configurationType()
@NonNull ConfigurationPath	copy()	Copy the state the of the path detaching it from any downstream mutations.
boolean	hasDynamicSegments()	A configuration can have dynamic segments if it is nested within a EachProperty instance.
int	index()
default boolean	isList()
boolean	isNotEmpty()
default boolean	isPrimary()
boolean	isWithin(String prefix)	Check whether the given prefix is within the current path.
ConfigurationPath.ConfigurationSegment.ConfigurationKind	kind()
@Nullable String	name()
static @NonNull ConfigurationPath	newPath()
static @NonNull ConfigurationPath	of(BeanDefinition<?>... definitions)	Computes the path for the given nested chain of definitions.
@Nullable ConfigurationPath	parent()
@NonNull String	path()
@Nullable ConfigurationPath.ConfigurationSegment	peekLast()
@NonNull String	prefix()	Compute the prefix to resolve properties based on the current state of the path and the given prefix.
@Nullable String	primary()
void	pushConfigurationReader(@NonNull BeanDefinition<?> beanDefinition)	Push a new configuration segment for the given name and kind
void	pushConfigurationSegment(int index)	Adds a indexed segment.
void	pushConfigurationSegment(@NonNull ConfigurationPath.ConfigurationSegment configurationSegment)	Push and adapt an existing configuration segment.
void	pushConfigurationSegment(@NonNull String name)	Adds a named segment.
void	pushEachPropertyRoot(@NonNull BeanDefinition<?> beanDefinition)	Push a new configuration segment for the given name and kind
@NonNull ConfigurationPath.ConfigurationSegment	removeLast()	remove last entry.
@NonNull String	resolveValue(String value)	Resolve the given value with the current state.
@Nullable String	simpleName()
void	traverseResolvableSegments(@NonNull PropertyResolver propertyResolver, @NonNull Consumer<ConfigurationPath> callback)	Traverse the enabled segments for this path invoking the given callback.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

newPath

@NonNull
static @NonNull ConfigurationPath newPath()

Returns:

Creates a new path.

of

@NonNull
static @NonNull ConfigurationPath of(BeanDefinition<?>... definitions)

Computes the path for the given nested chain of definitions.

Parameters:

definitions - The definitions

Returns:

THe computed path

hasDynamicSegments

boolean hasDynamicSegments()

A configuration can have dynamic segments if it is nested within a EachProperty instance.

Returns:

True if the path has any dynamic segments (ie types annotated with EachProperty

copy

@NonNull
@NonNull ConfigurationPath copy()

Copy the state the of the path detaching it from any downstream mutations.

Returns:

The copied path

parent

@Nullable
@Nullable ConfigurationPath parent()

Returns:

The parent of the current path.

prefix

@NonNull
@NonNull String prefix()

Compute the prefix to resolve properties based on the current state of the path and the given prefix.

Returns:

The resolved path

path

@NonNull
@NonNull String path()

Returns:

The path without segments substituted.

primary

@Nullable
@Nullable String primary()

Returns:

The current primary

kind

@NonNull
ConfigurationPath.ConfigurationSegment.ConfigurationKind kind()

Returns:

The current kind

name

@Nullable
@Nullable String name()

Returns:

The current bound name if any.

index

int index()

Returns:

The current index or -1 if there is none

beanQualifier

@Nullable
default <T> @Nullable Qualifier<T> beanQualifier()

Type Parameters:

T - The bean type

Returns:

The qualifier.

isList

default boolean isList()

Returns:

Is the current binding a list.

peekLast

@Nullable
@Nullable ConfigurationPath.ConfigurationSegment peekLast()

Returns:

The last entry.

isPrimary

default boolean isPrimary()

Returns:

Is the current segment the primary.

pushEachPropertyRoot

void pushEachPropertyRoot(@NonNull
 @NonNull BeanDefinition<?> beanDefinition)

Push a new configuration segment for the given name and kind

Parameters:

beanDefinition - The bean definition

pushConfigurationReader

void pushConfigurationReader(@NonNull
 @NonNull BeanDefinition<?> beanDefinition)

Push a new configuration segment for the given name and kind

Parameters:

beanDefinition - The bean definition

pushConfigurationSegment

void pushConfigurationSegment(@NonNull
 @NonNull String name)

Adds a named segment.

Parameters:

name - The name of the segment

pushConfigurationSegment

void pushConfigurationSegment(int index)

Adds a indexed segment.

Parameters:

index - The index of the segment

removeLast

@NonNull
@NonNull ConfigurationPath.ConfigurationSegment removeLast()

remove last entry.

Throws:

NoSuchElementException - if there isn't any remaining elements.

isNotEmpty

boolean isNotEmpty()

Returns:

Whether the path is not empty.

resolveValue

@NonNull
@NonNull String resolveValue(String value)

Resolve the given value with the current state.

Parameters:

value - The value

Returns:

The resolved value

configurationType

@Nullable
@Nullable Class<?> configurationType()

Returns:

The current configuration type.

simpleName

@Nullable
@Nullable String simpleName()

Returns:

The simple unqualified name if any.

traverseResolvableSegments

void traverseResolvableSegments(@NonNull
 @NonNull PropertyResolver propertyResolver,
 @NonNull
 @NonNull Consumer<ConfigurationPath> callback)

Traverse the enabled segments for this path invoking the given callback.

Parameters:

propertyResolver - The property resolver to use.

callback - The callback.

pushConfigurationSegment

void pushConfigurationSegment(@NonNull
 @NonNull ConfigurationPath.ConfigurationSegment configurationSegment)

Push and adapt an existing configuration segment.

Parameters:

configurationSegment - The configuration segment

isWithin

boolean isWithin(String prefix)

Check whether the given prefix is within the current path.

Parameters:

prefix - The prefix

Returns:

True if it is within the current path.