Module dev.orne.config

Package dev.orne.config.impl

Class YamlMutableConfigBuilderImpl

java.lang.Object

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

dev.orne.config.impl.AbstractMutableConfigBuilderImpl<YamlMutableConfigBuilder>

dev.orne.config.impl.YamlMutableConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<YamlMutableConfigBuilder>, MutableConfigBuilder<YamlMutableConfigBuilder>, YamlConfigBaseBuilder<YamlMutableConfigBuilder>, YamlMutableConfigBuilder

@API(status=INTERNAL,
     since="1.0")
public class YamlMutableConfigBuilderImpl
extends AbstractMutableConfigBuilderImpl<YamlMutableConfigBuilder>
implements YamlMutableConfigBuilder

Implementation of YAML files based mutable configuration builder.

Since:

1.0

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• YamlMutableConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull YamlConfigOptions	yamlOptions	The YAML based configuration options.

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

mutableOptions

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

options

Fields inherited from interface dev.orne.config.YamlConfigBaseBuilder

DEFAULT_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlMutableConfigBuilderImpl(@NotNull ConfigOptions options, @NotNull MutableConfigOptions mutableOptions, @NotNull YamlConfigOptions yamlOptions)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull YamlMutableConfigBuilder	add(@NotNull Map<String,String> values)	Adds the specified custom properties to the configuration properties.
@NotNull YamlMutableConfigImpl	build()	Creates the configuration instance.
@NotNull YamlMutableConfigBuilder	load(@NotNull File file)	Loads the configuration properties from the specified file.
@NotNull YamlMutableConfigBuilder	load(@NotNull String path)	Loads the configuration properties from the specified ClassLoader resource.
@NotNull YamlMutableConfigBuilder	load(@NotNull URL url)	Loads the configuration properties from the specified URL.
@NotNull YamlMutableConfigBuilder	load(@NotNull Path path)	Loads the configuration properties from the file in the specified path.
@NotNull YamlMutableConfigBuilder	withSeparator(@NotEmpty String separator)	Sets the configuration nested properties separator.

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

withEncoder

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

Methods inherited from interface dev.orne.config.MutableConfigBuilder

withEncoder

Field Details

yamlOptions

@NotNull
protected final @NotNull YamlConfigOptions yamlOptions

The YAML based configuration options.

Constructor Details

YamlMutableConfigBuilderImpl

protected YamlMutableConfigBuilderImpl(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull MutableConfigOptions mutableOptions,
 @NotNull
 @NotNull YamlConfigOptions yamlOptions)

Copy constructor.

Parameters:

options - The configuration options to copy.

mutableOptions - The mutable configuration options to copy.

yamlOptions - The YAML based configuration options to copy.

Method Details

withSeparator

@NotNull
public @NotNull YamlMutableConfigBuilder withSeparator(@NotEmpty
 @NotEmpty String separator)

Sets the configuration nested properties separator.

Specified by:

withSeparator in interface YamlConfigBaseBuilder<YamlMutableConfigBuilder>

Parameters:

separator - The configuration nested properties separator.

Returns:

This instance, for method chaining.

add

@NotNull
public @NotNull YamlMutableConfigBuilder add(@NotNull
 @NotNull Map<String,String> values)

Adds the specified custom properties to the configuration properties.

Note that property keys will be processed with the configured nested properties separator.

Specified by:

add in interface YamlConfigBaseBuilder<YamlMutableConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

load

@NotNull
public @NotNull YamlMutableConfigBuilder load(@NotNull
 @NotNull String path)

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface YamlConfigBaseBuilder<YamlMutableConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

@NotNull
public @NotNull YamlMutableConfigBuilder load(@NotNull
 @NotNull Path path)

Loads the configuration properties from the file in the specified path.

Specified by:

load in interface YamlConfigBaseBuilder<YamlMutableConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

@NotNull
public @NotNull YamlMutableConfigBuilder load(@NotNull
 @NotNull File file)

Loads the configuration properties from the specified file.

Specified by:

load in interface YamlConfigBaseBuilder<YamlMutableConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

@NotNull
public @NotNull YamlMutableConfigBuilder load(@NotNull
 @NotNull URL url)

Loads the configuration properties from the specified URL.

Specified by:

load in interface YamlConfigBaseBuilder<YamlMutableConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull YamlMutableConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<YamlMutableConfigBuilder>

Specified by:

build in interface MutableConfigBuilder<YamlMutableConfigBuilder>

Specified by:

build in interface YamlMutableConfigBuilder

Returns:

The configuration instance.