Module dev.orne.config

Package dev.orne.config.impl

Class SpringEnvironmentConfigBuilderImpl

java.lang.Object

dev.orne.config.impl.AbstractConfigBuilderImpl<SpringEnvironmentConfigBuilder>

dev.orne.config.impl.SpringEnvironmentConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<SpringEnvironmentConfigBuilder>, SpringEnvironmentConfigBuilder, SpringEnvironmentConfigInitialBuilder

@API(status=INTERNAL,
     since="1.0")
public class SpringEnvironmentConfigBuilderImpl
extends AbstractConfigBuilderImpl<SpringEnvironmentConfigBuilder>
implements SpringEnvironmentConfigInitialBuilder, SpringEnvironmentConfigBuilder

Implementation of Spring Environment based immutable configuration builder.

Since:

1.0

Version:

1.0, 2025-09

Author:

(w) Iker Hernaez

See Also:

• SpringEnvironmentConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull SpringEnvironmentConfigOptions	springOptions	The Spring Environment configuration options.

Fields inherited from class dev.orne.config.impl.AbstractConfigBuilderImpl

options

Constructor Summary

Constructors

Constructor	Description
SpringEnvironmentConfigBuilderImpl()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
@NotNull SpringEnvironmentConfigImpl	build()	Creates the configuration instance.
@NotNull SpringEnvironmentConfigBuilder	ofEnvironment(@NotNull org.springframework.core.env.Environment environment)	Selects the Spring Environment to use as source of configuration properties.
@NotNull SpringEnvironmentConfigBuilder	withIterableKeys()	Sets this configuration to support property keys iteration.

Methods inherited from class dev.orne.config.impl.AbstractConfigBuilderImpl

thisBuilder, withDecoder, withDecorator, withEncryption, withOverrideParentProperties, withParent, withVariableResolution

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.orne.config.ConfigBuilder

as, withDecoder, withDecorator, withEncryption, withOverrideParentProperties, withParent, withParent, withVariableResolution

Field Details

springOptions

@NotNull
protected final @NotNull SpringEnvironmentConfigOptions springOptions

The Spring Environment configuration options.

Constructor Details

SpringEnvironmentConfigBuilderImpl

public SpringEnvironmentConfigBuilderImpl()

Creates a new instance.

Method Details

ofEnvironment

@NotNull
public @NotNull SpringEnvironmentConfigBuilder ofEnvironment(@NotNull
 @NotNull org.springframework.core.env.Environment environment)

Selects the Spring Environment to use as source of configuration properties.

Specified by:

ofEnvironment in interface SpringEnvironmentConfigInitialBuilder

Parameters:

environment - The Spring Environment.

Returns:

Next builder, for method chaining.

withIterableKeys

@NotNull
public @NotNull SpringEnvironmentConfigBuilder withIterableKeys()

Sets this configuration to support property keys iteration.

If this method is not called, the resulting configuration will not support property keys iteration, and calling Config.getKeys() will throw a NonIterableConfigException.

Note that enabling property keys iteration requires a ConfigurableEnvironment and may have a performance impact, depending on the configured PropertySources.

Specified by:

withIterableKeys in interface SpringEnvironmentConfigBuilder

Returns:

This instance, for method chaining.

See Also:

• Config.getKeys()

build

@NotNull
public @NotNull SpringEnvironmentConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<SpringEnvironmentConfigBuilder>

Returns:

The configuration instance.