Module dev.orne.config

Package dev.orne.config.impl

Class XmlConfigBuilderImpl

java.lang.Object

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

dev.orne.config.impl.XmlConfigBuilderImpl

All Implemented Interfaces:

ConfigBuilder<XmlConfigBuilder>, MutableCapableConfigBuilder<XmlConfigBuilder,XmlMutableConfigBuilder>, XmlConfigBaseBuilder<XmlConfigBuilder>, XmlConfigBuilder

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

Implementation of XML files based configuration builder.

Since:

1.0

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• XmlConfigBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final XmlConfigOptions	xmlOptions	The XML based configuration options.

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

Constructor	Description
XmlConfigBuilderImpl()	Empty constructor.

Method Summary

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

Methods inherited from interface dev.orne.config.XmlConfigBaseBuilder

withEmptyDocument

Field Details

xmlOptions

protected final XmlConfigOptions xmlOptions

The XML based configuration options.

Constructor Details

XmlConfigBuilderImpl

public XmlConfigBuilderImpl()

Empty constructor.

Method Details

withSeparator

public XmlConfigBuilder withSeparator(String separator)

Sets the configuration nested properties separator.

Specified by:

withSeparator in interface XmlConfigBaseBuilder<XmlConfigBuilder>

Parameters:

separator - The configuration nested properties separator.

Returns:

This instance, for method chaining.

withAttributePrefix

public XmlConfigBuilder withAttributePrefix(String prefix)

Sets the XML attributes references prefix.

Specified by:

withAttributePrefix in interface XmlConfigBaseBuilder<XmlConfigBuilder>

Parameters:

prefix - The XML attributes references prefix.

Returns:

This instance, for method chaining.

withEmptyDocument

public XmlConfigBuilder withEmptyDocument(@Nullable String namespaceURI,
 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<XmlConfigBuilder>

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

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

Parameters:

values - The configuration properties.

Returns:

This instance, for method chaining.

add

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

Parameters:

values - The configuration properties to add.

Returns:

This instance, for method chaining.

load

public XmlConfigBuilder load(String path)

Loads the configuration properties from the specified ClassLoader resource.

Specified by:

load in interface XmlConfigBaseBuilder<XmlConfigBuilder>

Parameters:

path - The ClassLoader resource path.

Returns:

This instance, for method chaining.

load

public XmlConfigBuilder load(Path path)

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

Specified by:

load in interface XmlConfigBaseBuilder<XmlConfigBuilder>

Parameters:

path - The file path.

Returns:

This instance, for method chaining.

load

public XmlConfigBuilder load(File file)

Loads the configuration properties from the specified file.

Specified by:

load in interface XmlConfigBaseBuilder<XmlConfigBuilder>

Parameters:

file - The file to load.

Returns:

This instance, for method chaining.

load

public XmlConfigBuilder load(URL url)

Loads the configuration properties from the specified URL.

Specified by:

load in interface XmlConfigBaseBuilder<XmlConfigBuilder>

Parameters:

url - The URL to load.

Returns:

This instance, for method chaining.

mutable

public XmlMutableConfigBuilder mutable()

Makes the configuration instance mutable.

Specified by:

mutable in interface MutableCapableConfigBuilder<XmlConfigBuilder,XmlMutableConfigBuilder>

Specified by:

mutable in interface XmlConfigBuilder

Returns:

This instance, for method chaining.

build

public XmlConfigImpl build()

Creates the configuration instance.

Specified by:

build in interface ConfigBuilder<XmlConfigBuilder>

Returns:

The configuration instance.