Module dev.orne.config

Package dev.orne.config.impl

Class XmlMutableConfigBuilderImpl

java.lang.Object

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

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

dev.orne.config.impl.XmlMutableConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<XmlMutableConfigBuilder>, MutableConfigBuilder<XmlMutableConfigBuilder>, XmlConfigBaseBuilder<XmlMutableConfigBuilder>, XmlMutableConfigBuilder

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

Implementation of XML files based mutable configuration builder.

Since:

1.0

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• XmlMutableConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull XmlConfigOptions	xmlOptions	The XML 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.XmlConfigBaseBuilder

DEFAULT_ATTRIBUTE_PREFIX, DEFAULT_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlMutableConfigBuilderImpl(@NotNull ConfigOptions options, @NotNull MutableConfigOptions mutableOptions, @NotNull XmlConfigOptions xmlOptions)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull XmlMutableConfigBuilder	add(@NotNull Map<String,String> values)	Adds the specified custom properties to the configuration properties.
@NotNull XmlMutableConfigBuilder	add(@NotNull Document values)	Adds the specified custom properties to the configuration properties.
@NotNull XmlMutableConfigImpl	build()	Creates the configuration instance.
@NotNull XmlMutableConfigBuilder	load(@NotNull File file)	Loads the configuration properties from the specified file.
@NotNull XmlMutableConfigBuilder	load(@NotNull String path)	Loads the configuration properties from the specified ClassLoader resource.
@NotNull XmlMutableConfigBuilder	load(@NotNull URL url)	Loads the configuration properties from the specified URL.
@NotNull XmlMutableConfigBuilder	load(@NotNull Path path)	Loads the configuration properties from the file in the specified path.
@NotNull XmlMutableConfigBuilder	withAttributePrefix(@NotEmpty String prefix)	Sets the XML attributes references prefix.
@NotNull XmlMutableConfigBuilder	withEmptyDocument(String namespaceURI, @NotNull String rootElementName)	Creates an empty XML document with the specified root element name as configuration properties container.
@NotNull XmlMutableConfigBuilder	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

Methods inherited from interface dev.orne.config.XmlConfigBaseBuilder

withEmptyDocument

Field Details

xmlOptions

@NotNull
protected final @NotNull XmlConfigOptions xmlOptions

The XML based configuration options.

Constructor Details

XmlMutableConfigBuilderImpl

protected XmlMutableConfigBuilderImpl(@NotNull
 @NotNull ConfigOptions options,
 @NotNull
 @NotNull MutableConfigOptions mutableOptions,
 @NotNull
 @NotNull XmlConfigOptions xmlOptions)

Copy constructor.

Parameters:

options - The configuration options to copy.

mutableOptions - The mutable configuration options to copy.

xmlOptions - The XML based configuration options to copy.

Method Details

withSeparator

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

Sets the configuration nested properties separator.

Specified by:

withSeparator in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

separator - The configuration nested properties separator.

Returns:

This instance, for method chaining.

withAttributePrefix

@NotNull
public @NotNull XmlMutableConfigBuilder withAttributePrefix(@NotEmpty
 @NotEmpty String prefix)

Sets the XML attributes references prefix.

Specified by:

withAttributePrefix in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

prefix - The XML attributes references prefix.

Returns:

This instance, for method chaining.

withEmptyDocument

@NotNull
public @NotNull XmlMutableConfigBuilder withEmptyDocument(String namespaceURI,
 @NotNull
 @NotNull String rootElementName)

Creates an empty XML document with the specified root element name as configuration properties container.

Note that any XML document loaded through load() methods must match the same root element name.

Specified by:

withEmptyDocument in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

namespaceURI - The XML document namespace URI.

rootElementName - The root element name of the XML document to create.

Returns:

This instance, for method chaining.

add

@NotNull
public @NotNull XmlMutableConfigBuilder add(@NotNull
 @NotNull Document 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 XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

add

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

Adds the specified custom properties to the configuration properties.

Note that an existing document is required to have been created with withEmptyDocument() or load() methtods, so that the XML document has a root element to contain the properties, and that property keys will be processed with the configured nested properties separator and attribute prefix.

Specified by:

add in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

values - The configuration properties to add.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

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

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

Specified by:

load in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified file.

Specified by:

load in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

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

Loads the configuration properties from the specified URL.

Specified by:

load in interface XmlConfigBaseBuilder<XmlMutableConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

build

@NotNull
public @NotNull XmlMutableConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<XmlMutableConfigBuilder>

Specified by:

build in interface MutableConfigBuilder<XmlMutableConfigBuilder>

Specified by:

build in interface XmlMutableConfigBuilder

Returns:

The configuration instance.