Module dev.orne.config

Package dev.orne.config.impl

Class PropertiesMutableConfigBuilderImpl

java.lang.Object

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

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

dev.orne.config.impl.PropertiesMutableConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<PropertiesMutableConfigBuilder>, MutableConfigBuilder<PropertiesMutableConfigBuilder>, PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>, PropertiesMutableConfigBuilder

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

Implementation of Properties based mutable configuration builder.

Since:

1.0

Version:

1.0, 2025-05

Author:

(w) Iker Hernaez

See Also:

• PropertiesMutableConfigBuilder

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

mutableOptions

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

options

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PropertiesMutableConfigBuilderImpl(@NotNull ConfigOptions options, @NotNull MutableConfigOptions mutableOptions, @NotNull PropertiesConfigOptions propertyOptions)	Copy constructor.

Method Summary

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

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

propertyOptions

@NotNull
protected final @NotNull PropertiesConfigOptions propertyOptions

The properties based configuration options.

Constructor Details

PropertiesMutableConfigBuilderImpl

protected PropertiesMutableConfigBuilderImpl(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull MutableConfigOptions mutableOptions,
 @NotNull
 @NotNull PropertiesConfigOptions propertyOptions)

Copy constructor.

Parameters:

options - The configuration options to copy.

mutableOptions - The mutable configuration options to copy.

propertyOptions - The properties based configuration options to copy.

Method Details

add

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

Adds the specified configuration properties to the configuration properties.

Specified by:

add in interface PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

add

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

Adds the specified configuration properties to the configuration properties.

Specified by:

add in interface PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

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

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

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified file.

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified URL.

Specified by:

load in interface PropertiesConfigBaseBuilder<PropertiesMutableConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull PropertiesMutableConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<PropertiesMutableConfigBuilder>

Specified by:

build in interface MutableConfigBuilder<PropertiesMutableConfigBuilder>

Specified by:

build in interface PropertiesMutableConfigBuilder

Returns:

The configuration instance.