Package org.apache.commons.configuration2

Class AbstractYAMLBasedConfiguration

java.lang.Object

org.apache.commons.configuration2.event.BaseEventSource

org.apache.commons.configuration2.AbstractConfiguration

org.apache.commons.configuration2.AbstractHierarchicalConfiguration<ImmutableNode>

org.apache.commons.configuration2.BaseHierarchicalConfiguration

org.apache.commons.configuration2.AbstractYAMLBasedConfiguration

All Implemented Interfaces:

Cloneable, Configuration, EventSource, HierarchicalConfiguration<ImmutableNode>, ImmutableConfiguration, ImmutableHierarchicalConfiguration, SynchronizerSupport, InMemoryNodeModelSupport, NodeKeyResolver<ImmutableNode>, NodeModelSupport<ImmutableNode>

Direct Known Subclasses:

JSONConfiguration, YAMLConfiguration

public class AbstractYAMLBasedConfiguration
extends BaseHierarchicalConfiguration

A base class for configuration implementations based on YAML structures.

This base class offers functionality related to YAML-like data structures based on maps. Such a map has strings as keys and arbitrary objects as values. The class offers methods to transform such a map into a hierarchy of ImmutableNode objects and vice versa.

Since:

2.2

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.configuration2.BaseHierarchicalConfiguration

BaseHierarchicalConfiguration.BuilderVisitor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractYAMLBasedConfiguration()	Creates a new instance of AbstractYAMLBasedConfiguration.
protected	AbstractYAMLBasedConfiguration(HierarchicalConfiguration<ImmutableNode> c)	Creates a new instance of AbstractYAMLBasedConfiguration as a copy of the specified configuration.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	constructMap(ImmutableNode node)	Constructs a YAML map, i.e.
protected void	load(Map<String,Object> map)	Loads this configuration from the content of the specified map.

Methods inherited from class org.apache.commons.configuration2.BaseHierarchicalConfiguration

childConfigurationsAt, childConfigurationsAt, cloneNodeModel, configurationAt, configurationAt, configurationsAt, configurationsAt, createSubConfigurationForTrackedNode, getNodeModel, getSubConfigurationNodeSelector, getSubConfigurationParentModel, immutableChildConfigurationsAt, immutableConfigurationAt, immutableConfigurationAt, immutableConfigurationsAt, initSubConfigurationForThisParent, interpolatedConfiguration, subnodeConfigurationChanged, subset

Methods inherited from class org.apache.commons.configuration2.AbstractHierarchicalConfiguration

addNodes, addNodesInternal, addPropertyDirect, addPropertyInternal, clearInternal, clearPropertyDirect, clearTree, clearTreeInternal, clone, containsKeyInternal, fetchNodeList, getExpressionEngine, getKeysInternal, getKeysInternal, getMaxIndex, getMaxIndexInternal, getModel, getPropertyInternal, getRootElementName, getRootElementNameInternal, isEmptyInternal, nodeDefined, nodeKey, resolveAddKey, resolveKey, resolveNodeKey, resolveUpdateKey, setExpressionEngine, setPropertyInternal, sizeInternal, toString

Methods inherited from class org.apache.commons.configuration2.AbstractConfiguration

addErrorLogListener, addProperty, append, beginRead, beginWrite, clear, clearProperty, cloneInterpolator, containsKey, copy, endRead, endWrite, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getConfigurationDecoder, getConversionHandler, getDouble, getDouble, getDouble, getDuration, getDuration, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getKeys, getKeys, getKeysInternal, getList, getList, getList, getList, getListDelimiterHandler, getLogger, getLong, getLong, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, getSynchronizer, immutableSubset, initLogger, installInterpolator, interpolate, interpolate, isEmpty, isScalarValue, isThrowExceptionOnMissing, lock, setConfigurationDecoder, setConversionHandler, setDefaultLookups, setInterpolator, setListDelimiterHandler, setLogger, setParentInterpolator, setPrefixLookups, setProperty, setSynchronizer, setThrowExceptionOnMissing, size, unlock

Methods inherited from class org.apache.commons.configuration2.event.BaseEventSource

addEventListener, clearErrorListeners, clearEventListeners, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.configuration2.Configuration

addProperty, clear, clearProperty, getInterpolator, installInterpolator, setInterpolator, setProperty

Methods inherited from interface org.apache.commons.configuration2.ImmutableConfiguration

containsKey, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getDouble, getDouble, getDouble, getDuration, getDuration, getEncodedString, getEncodedString, getEnum, getEnum, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getKeys, getKeys, getList, getList, getList, getList, getLong, getLong, getLong, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, immutableSubset, isEmpty, size

Methods inherited from interface org.apache.commons.configuration2.sync.SynchronizerSupport

getSynchronizer, lock, setSynchronizer, unlock

Constructor Details

AbstractYAMLBasedConfiguration

protected AbstractYAMLBasedConfiguration()

Creates a new instance of AbstractYAMLBasedConfiguration.

AbstractYAMLBasedConfiguration

protected AbstractYAMLBasedConfiguration(HierarchicalConfiguration<ImmutableNode> c)

Creates a new instance of AbstractYAMLBasedConfiguration as a copy of the specified configuration.

Parameters:

c - the configuration to be copied

Method Details

load

protected void load(Map<String,Object> map)

Loads this configuration from the content of the specified map. The data in the map is transformed into a hierarchy of ImmutableNode objects.

Parameters:

map - the map to be processed

constructMap

protected Map<String,Object> constructMap(ImmutableNode node)

Constructs a YAML map, i.e. String -> Object from a given configuration node.

Parameters:

node - The configuration node to create a map from.

Returns:

A Map that contains the configuration node information.