Module dev.orne.config

Package dev.orne.config.impl

Class JsonConfigBuilderImpl

java.lang.Object

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

dev.orne.config.impl.JsonConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<JsonConfigBuilder>, JsonConfigBaseBuilder<JsonConfigBuilder>, JsonConfigBuilder, MutableCapableConfigBuilder<JsonConfigBuilder>

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

Implementation of Jackson ObjectNode based immutable configuration builder.

Since:

1.0

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• JsonConfigBuilder

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

options

Fields inherited from interface dev.orne.config.JsonConfigBaseBuilder

DEFAULT_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
JsonConfigBuilderImpl()	Empty constructor.

Method Summary

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

jsonOptions

@NotNull
protected final @NotNull JsonConfigOptions jsonOptions

The JSON based configuration options.

Constructor Details

JsonConfigBuilderImpl

public JsonConfigBuilderImpl()

Empty constructor.

Method Details

withSeparator

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

Sets the configuration nested properties separator.

Specified by:

withSeparator in interface JsonConfigBaseBuilder<JsonConfigBuilder>

Parameters:

separator - The configuration nested properties separator.

Returns:

This instance, for method chaining.

add

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

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface JsonConfigBaseBuilder<JsonConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

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

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

Specified by:

load in interface JsonConfigBaseBuilder<JsonConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified file.

Specified by:

load in interface JsonConfigBaseBuilder<JsonConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified URL.

Specified by:

load in interface JsonConfigBaseBuilder<JsonConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

mutable

@NotNull
public @NotNull JsonMutableConfigBuilderImpl mutable()

Makes the configuration instance mutable.

Specified by:

mutable in interface JsonConfigBuilder

Specified by:

mutable in interface MutableCapableConfigBuilder<JsonConfigBuilder>

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull JsonConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<JsonConfigBuilder>

Returns:

The configuration instance.