Package io.confound.config.file.format.xml

Class XmlConfiguration

  • All Implemented Interfaces:
    io.confound.config.Configuration
    public class XmlConfiguration
extends io.confound.config.AbstractStringConfiguration
    Implementation of a configuration based on a XML file format.
    Author:
    Magno N A Cruz

    • Field Summary

      • Fields inherited from interface io.confound.config.Configuration

        KEY_SEGMENT_SEPARATOR, KEY_SEGMENTS_PATTERN

    • Constructor Summary

      Constructors 
      Constructor Description
      XmlConfiguration​(org.w3c.dom.Document xmlDocument)
      Constructor of the configuration.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.util.Optional<java.lang.String> findConfigurationValueImpl​(java.lang.String key)  
      java.util.Optional<io.confound.config.Section> findSection​(java.lang.String key)

      • Methods inherited from class io.confound.config.AbstractStringConfiguration

        dereferenceString, findBoolean, findConfigurationValue, findDouble, findInt, findLong, findObject, findPath, findString, findUri

      • Methods inherited from class io.confound.config.BaseConfiguration

        convertValue, findCollection, hasConfigurationValue, hasConfigurationValueImpl, normalizeKey

      • Methods inherited from class io.confound.config.AbstractConfiguration

        or

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface io.confound.config.Configuration

        createMissingConfigurationKeyException, findCollection, findObject, getBoolean, getCollection, getCollection, getDouble, getInt, getLong, getObject, getObject, getPath, getSection, getString, getUri, requireConfiguration, resolvePath, subConfiguration, superConfiguration, withFallback

    • Constructor Detail

      • XmlConfiguration

        public XmlConfiguration​(@Nonnull
                        org.w3c.dom.Document xmlDocument)
        Constructor of the configuration.
        Parameters:
        xmlDocument - The XML tree node to be used as the configuration.

    • Method Detail

      • findSection

        public java.util.Optional<io.confound.config.Section> findSection​(java.lang.String key)
                                                           throws io.confound.config.ConfigurationException
        Implementation Specification:
        The simple XML implementation does not support sections, so this implementation always returns Optional.empty().
        Throws:
        io.confound.config.ConfigurationException

      • findConfigurationValueImpl

        protected java.util.Optional<java.lang.String> findConfigurationValueImpl​(@Nonnull
                                                                          java.lang.String key)
                                                                   throws io.confound.config.ConfigurationException
        Specified by:
        findConfigurationValueImpl in class io.confound.config.BaseConfiguration<java.lang.String>
        Throws:
        io.confound.config.ConfigurationException