Module dev.orne.config

Package dev.orne.config.impl

Class XmlConfigImpl

java.lang.Object

dev.orne.config.impl.AbstractConfig

dev.orne.config.impl.AbstractMutableConfig

dev.orne.config.impl.AbstractWatchableConfig

dev.orne.config.impl.XmlConfigImpl

All Implemented Interfaces:

Config

Direct Known Subclasses:

XmlMutableConfigImpl

@API(status=INTERNAL,
     since="1.0")
public class XmlConfigImpl
extends AbstractWatchableConfig

Implementation of Config based on a XML document.

Since:

0.1

Version:

1.0, 2025-07

Author:

(w) Iker Hernaez

See Also:

• Config

Field Summary

Fields inherited from class dev.orne.config.impl.AbstractConfig

KEY_BLANK_ERR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlConfigImpl(ConfigOptions options, MutableConfigOptions mutableOptions, XmlConfigOptions xmlOptions)	Creates a new instance.
	XmlConfigImpl(ConfigOptions options, XmlConfigOptions xmlOptions)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	containsInt(String key)	Returns true if the property with the key passed as argument has been configured in this configuration instance.
protected String	getAttributePrefix()	Returns the XML attributes references prefix.
protected Document	getDocument()	Returns the XML document with the configuration options.
protected @Nullable String	getInt(String key)	Returns the value of the configuration property as String.
protected Stream<String>	getKeysInt()	Returns the configuration property keys contained in this configuration instance .
protected String	getPropertySeparator()	Returns the configuration nested properties separator.
protected boolean	isEmptyInt()	Returns true if this configuration instance contains no property.

Methods inherited from class dev.orne.config.impl.AbstractWatchableConfig

addListener, getEvents, notifyLocalChanges, notifyParentChanges, remove, removeListener, set

Methods inherited from class dev.orne.config.impl.AbstractMutableConfig

getEncoder, removeInt, setInt

Methods inherited from class dev.orne.config.impl.AbstractConfig

contains, get, getDecoder, getDecorator, getKeys, getParent, getResolver, getUndecored, isEmpty, isOverrideParentProperties

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

as, get, get, getBoolean, getBoolean, getBoolean, getInteger, getInteger, getInteger, getKeys, getKeys, getLong, getLong, getLong, subset

Constructor Details

XmlConfigImpl

public XmlConfigImpl(ConfigOptions options,
 XmlConfigOptions xmlOptions)

Creates a new instance.

Parameters:

options - The configuration builder options.

xmlOptions - The XML based configuration builder options.

XmlConfigImpl

protected XmlConfigImpl(ConfigOptions options,
 MutableConfigOptions mutableOptions,
 XmlConfigOptions xmlOptions)

Creates a new instance.

Parameters:

options - The configuration builder options.

mutableOptions - The mutable configuration builder options.

xmlOptions - The XML based configuration builder options.

Method Details

getDocument

protected Document getDocument()

Returns the XML document with the configuration options.

Returns:

The XML document with the configuration options.

getPropertySeparator

protected String getPropertySeparator()

Returns the configuration nested properties separator.

Returns:

The configuration nested properties separator.

getAttributePrefix

protected String getAttributePrefix()

Returns the XML attributes references prefix.

Returns:

The XML attributes references prefix.

isEmptyInt

protected boolean isEmptyInt()

Returns true if this configuration instance contains no property.

Parent configuration

Specified by:

isEmptyInt in class AbstractConfig

Returns:

Returns true if the configuration contains no property.

containsInt

protected boolean containsInt(String key)

Returns true if the property with the key passed as argument has been configured in this configuration instance.

Specified by:

containsInt in class AbstractConfig

Parameters:

key - The configuration property.

Returns:

Returns true if the property has been configured.

getKeysInt

protected Stream<String> getKeysInt()

Returns the configuration property keys contained in this configuration instance .

Specified by:

getKeysInt in class AbstractConfig

Returns:

The configuration property keys.

getInt

protected @Nullable String getInt(String key)

Returns the value of the configuration property as String.

Specified by:

getInt in class AbstractConfig

Parameters:

key - The configuration property.

Returns:

The configuration parameter value.