Module dev.orne.config

Package dev.orne.config.impl

Class PropertiesConfigBuilderImpl

java.lang.Object

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

dev.orne.config.impl.PropertiesConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<PropertiesConfigBuilder>, MutableCapableConfigBuilder<PropertiesConfigBuilder>, PropertiesConfigBaseBuilder<PropertiesConfigBuilder>, PropertiesConfigBuilder

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

Implementation of Properties based immutable configuration builder.

Since:

1.0

Version:

1.0, 2025-05

Author:

(w) Iker Hernaez

See Also:

• PropertiesConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull PropertiesConfigOptions	propertyOptions	The properties based configuration options.

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

options

Constructor Summary

Constructors

Constructor	Description
PropertiesConfigBuilderImpl()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull PropertiesConfigBuilder	add(@NotNull Map<String,String> values)	Adds the specified configuration properties to the configuration properties.
@NotNull PropertiesConfigBuilder	add(@NotNull Properties values)	Adds the specified configuration properties to the configuration properties.
@NotNull PropertiesConfigImpl	build()	Creates the configuration instance.
@NotNull PropertiesConfigBuilder	load(@NotNull File file)	Loads the configuration properties from the specified file.
@NotNull PropertiesConfigBuilder	load(@NotNull String path)	Loads the configuration properties from the specified ClassLoader resource.
@NotNull PropertiesConfigBuilder	load(@NotNull URL url)	Loads the configuration properties from the specified URL.
@NotNull PropertiesConfigBuilder	load(@NotNull Path path)	Loads the configuration properties from the file in the specified path.
@NotNull PropertiesMutableConfigBuilderImpl	mutable()	Makes the configuration instance mutable.

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

propertyOptions

@NotNull
protected final @NotNull PropertiesConfigOptions propertyOptions

The properties based configuration options.

Constructor Details

PropertiesConfigBuilderImpl

public PropertiesConfigBuilderImpl()

Empty constructor.

Method Details

add

@NotNull
public @NotNull PropertiesConfigBuilder add(@NotNull
 @NotNull Properties values)

Adds the specified configuration properties to the configuration properties.

Specified by:

add in interface PropertiesConfigBaseBuilder<PropertiesConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

add

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

Adds the specified configuration properties to the configuration properties.

Specified by:

add in interface PropertiesConfigBaseBuilder<PropertiesConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

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

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

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified file.

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified URL.

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

mutable

@NotNull
public @NotNull PropertiesMutableConfigBuilderImpl mutable()

Makes the configuration instance mutable.

Specified by:

mutable in interface MutableCapableConfigBuilder<PropertiesConfigBuilder>

Specified by:

mutable in interface PropertiesConfigBuilder

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull PropertiesConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<PropertiesConfigBuilder>

Returns:

The configuration instance.