com.cerner.beadledom.configuration

Class XmlConfigurationSource

java.lang.Object

com.cerner.beadledom.configuration.AbstractConfigurationSource

com.cerner.beadledom.configuration.XmlConfigurationSource

All Implemented Interfaces:

ConfigurationSource, Comparable<ConfigurationSource>

public final class XmlConfigurationSource
extends AbstractConfigurationSource

An implementation class of ConfigurationSource for the source of type XMLConfiguration.

A property whose value is a sequence (ex: list, set) of objects must be placed in its own attribute name. For example

   <?xml version="1.0" encoding="UTF-8" ?>
   <config>
     <name>Lays</name>
     <type>Potato Chips</type>
     <flavors>
         <flavor>Barbecue</flavor>
         <flavor>Onion Cream</flavor>
     </flavors>
   </config>
 

The sequence values are accessed by fully qualifying the name of the attributes.

   config.getList("flavors.flavor");
 

Since:

1.7

Author:

Sundeep Paruvu

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
static XmlConfigurationSource	create(Reader reader) Creates an instance of XmlConfigurationSource.
static XmlConfigurationSource	create(Reader reader, int priority) Creates an instance of XmlConfigurationSource.
org.apache.commons.configuration2.Configuration	getConfig() Returns the Configuration from the ConfigurationSource.
int	getPriority() Returns the priority of the current ConfigurationSources among other ConfigurationSources.

Methods inherited from class com.cerner.beadledom.configuration.AbstractConfigurationSource

compareTo, equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

create

public static XmlConfigurationSource create(Reader reader)
                                     throws org.apache.commons.configuration2.ex.ConfigurationException,
                                            IOException

Creates an instance of XmlConfigurationSource.

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - when fails to create the XMLConfiguration

IOException - when fails to read from the reader

NullPointerException - if the path to the xml file is null

create

public static XmlConfigurationSource create(Reader reader,
                                            int priority)
                                     throws org.apache.commons.configuration2.ex.ConfigurationException

Creates an instance of XmlConfigurationSource.

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - when fails to create the XMLConfiguration

NullPointerException - if the path to the xml file is null

IllegalArgumentException - if the path to the xml file is not valid or the priority is a negative value

getConfig

public org.apache.commons.configuration2.Configuration getConfig()

Description copied from interface: ConfigurationSource

Returns the Configuration from the ConfigurationSource.

Returns:

a Configuration object.

getPriority

public int getPriority()

Description copied from interface: ConfigurationSource

Returns the priority of the current ConfigurationSources among other ConfigurationSources.

The return value signifies the natural ordering of the instances. Greater Value implies higher priority. Higher Priority ConfigurationSources overrides any matching properties from the lower priority ConfigurationSources.

The priority on a ConfigurationSource must not be negative.

Returns:

an integer indicating the priority of the configuration.