Module dev.orne.config

Package dev.orne.config.impl

Class YamlConfigBuilderImpl

java.lang.Object

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

dev.orne.config.impl.YamlConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<YamlConfigBuilder>, MutableCapableConfigBuilder<YamlConfigBuilder>, YamlConfigBaseBuilder<YamlConfigBuilder>, YamlConfigBuilder

@API(status=INTERNAL,
     since="1.0")
public class YamlConfigBuilderImpl
extends AbstractConfigBuilderImpl<YamlConfigBuilder>
implements YamlConfigBuilder

Implementation of YAML files based configuration builder.

Since:

1.0

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• YamlConfigBuilder

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.AbstractConfigBuilderImpl

options

Fields inherited from interface dev.orne.config.YamlConfigBaseBuilder

DEFAULT_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
YamlConfigBuilderImpl()	Empty constructor.

Method Summary

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

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

yamlOptions

@NotNull
protected final @NotNull YamlConfigOptions yamlOptions

The YAML based configuration options.

Constructor Details

YamlConfigBuilderImpl

public YamlConfigBuilderImpl()

Empty constructor.

Method Details

withSeparator

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

Sets the configuration nested properties separator.

Specified by:

withSeparator in interface YamlConfigBaseBuilder<YamlConfigBuilder>

Parameters:

separator - The configuration nested properties separator.

Returns:

This instance, for method chaining.

add

@NotNull
public @NotNull YamlConfigBuilder 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<YamlConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface YamlConfigBaseBuilder<YamlConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

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

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

Specified by:

load in interface YamlConfigBaseBuilder<YamlConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified file.

Specified by:

load in interface YamlConfigBaseBuilder<YamlConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified URL.

Specified by:

load in interface YamlConfigBaseBuilder<YamlConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

mutable

@NotNull
public @NotNull YamlMutableConfigBuilder mutable()

Makes the configuration instance mutable.

Specified by:

mutable in interface MutableCapableConfigBuilder<YamlConfigBuilder>

Specified by:

mutable in interface YamlConfigBuilder

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull YamlConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<YamlConfigBuilder>

Returns:

The configuration instance.