Module dev.orne.config

Package dev.orne.config.impl

Class JsonMutableConfigBuilderImpl

java.lang.Object

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

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

dev.orne.config.impl.JsonMutableConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<JsonMutableConfigBuilder>, JsonConfigBaseBuilder<JsonMutableConfigBuilder>, JsonMutableConfigBuilder, MutableConfigBuilder<JsonMutableConfigBuilder>

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

Implementation of Jackson ObjectNode based mutable configuration builder.

Since:

1.0

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• JsonMutableConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull JsonConfigOptions	jsonOptions	The JSON 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.JsonConfigBaseBuilder

DEFAULT_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonMutableConfigBuilderImpl(@NotNull ConfigOptions options, @NotNull MutableConfigOptions mutableOptions, @NotNull JsonConfigOptions jsonOptions)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull JsonMutableConfigBuilder	add(@NotNull Map<String,String> values)	Adds the specified custom properties to the configuration properties.
@NotNull JsonMutableConfigImpl	build()	Creates the configuration instance.
@NotNull JsonMutableConfigBuilder	load(@NotNull File file)	Loads the configuration properties from the specified file.
@NotNull JsonMutableConfigBuilder	load(@NotNull String path)	Loads the configuration properties from the specified ClassLoader resource.
@NotNull JsonMutableConfigBuilder	load(@NotNull URL url)	Loads the configuration properties from the specified URL.
@NotNull JsonMutableConfigBuilder	load(@NotNull Path path)	Loads the configuration properties from the file in the specified path.
@NotNull JsonMutableConfigBuilder	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

jsonOptions

@NotNull
protected final @NotNull JsonConfigOptions jsonOptions

The JSON based configuration options.

Constructor Details

JsonMutableConfigBuilderImpl

protected JsonMutableConfigBuilderImpl(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull MutableConfigOptions mutableOptions,
 @NotNull
 @NotNull JsonConfigOptions jsonOptions)

Copy constructor.

Parameters:

options - The configuration options to copy.

mutableOptions - The mutable configuration options to copy.

jsonOptions - The JSON based configuration options to copy.

Method Details

withSeparator

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

Sets the configuration nested properties separator.

Specified by:

withSeparator in interface JsonConfigBaseBuilder<JsonMutableConfigBuilder>

Parameters:

separator - The configuration nested properties separator.

Returns:

This instance, for method chaining.

add

@NotNull
public @NotNull JsonMutableConfigBuilder 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 JsonConfigBaseBuilder<JsonMutableConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface JsonConfigBaseBuilder<JsonMutableConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

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

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

Specified by:

load in interface JsonConfigBaseBuilder<JsonMutableConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified file.

Specified by:

load in interface JsonConfigBaseBuilder<JsonMutableConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified URL.

Specified by:

load in interface JsonConfigBaseBuilder<JsonMutableConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull JsonMutableConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<JsonMutableConfigBuilder>

Specified by:

build in interface JsonMutableConfigBuilder

Specified by:

build in interface MutableConfigBuilder<JsonMutableConfigBuilder>

Returns:

The configuration instance.