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,JsonMutableConfigBuilder>

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

protected final JsonConfigOptions jsonOptions

The JSON based configuration options.

Constructor Details

JsonConfigBuilderImpl

public JsonConfigBuilderImpl()

Empty constructor.

Method Details

withSeparator

public JsonConfigBuilder withSeparator(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

public JsonConfigBuilder add(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

public JsonConfigBuilder load(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

public JsonConfigBuilder load(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

public JsonConfigBuilder load(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

public JsonConfigBuilder load(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

public JsonMutableConfigBuilderImpl mutable()

Makes the configuration instance mutable.

Specified by:

mutable in interface JsonConfigBuilder

Specified by:

mutable in interface MutableCapableConfigBuilder<JsonConfigBuilder,JsonMutableConfigBuilder>

Returns:

This instance, for method chaining.

build

public JsonConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<JsonConfigBuilder>

Returns:

The configuration instance.