io.urf.apache.commons.configuration2.surf

Class SurfConfiguration

java.lang.Object

org.apache.commons.configuration2.event.BaseEventSource

org.apache.commons.configuration2.AbstractConfiguration

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

org.apache.commons.configuration2.BaseHierarchicalConfiguration

io.urf.apache.commons.configuration2.surf.SurfConfiguration

All Implemented Interfaces:

Cloneable, org.apache.commons.configuration2.Configuration, org.apache.commons.configuration2.event.EventSource, org.apache.commons.configuration2.FileBasedConfiguration, org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>, org.apache.commons.configuration2.ImmutableConfiguration, org.apache.commons.configuration2.ImmutableHierarchicalConfiguration, org.apache.commons.configuration2.io.FileBased, org.apache.commons.configuration2.sync.SynchronizerSupport, org.apache.commons.configuration2.tree.InMemoryNodeModelSupport, org.apache.commons.configuration2.tree.NodeKeyResolver<org.apache.commons.configuration2.tree.ImmutableNode>, org.apache.commons.configuration2.tree.NodeModelSupport<org.apache.commons.configuration2.tree.ImmutableNode>

public class SurfConfiguration
extends org.apache.commons.configuration2.BaseHierarchicalConfiguration
implements org.apache.commons.configuration2.FileBasedConfiguration

An implementation for a FileBasedConfiguration that uses a SURF file to store information.

If a SURF configuration file is created by an instance of this class, it will be composed by a root SurfObject with the type name defined as "Configuration", and every property added to this SurfConfiguration instance will be a child of this SurfObject.

i.e.,

 *Configuration:
   property1 = value1
   property2 = value2
   property3 = value3
 ;
 

The SURF document serialized will always be formatter. See SurfSerializer.setFormatted(boolean).

Author:

Magno N A Cruz

Nested Class Summary

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

org.apache.commons.configuration2.BaseHierarchicalConfiguration.BuilderVisitor

Constructor Summary

Constructors

Constructor and Description
SurfConfiguration()

Method Summary

Modifier and Type	Method and Description
protected void	addPropertyInternal(String key, Object obj)
protected void	clearPropertyDirect(String key)
protected Object	getPropertyInternal(String key)
io.urf.surf.parser.SurfObject	getSurfDocument() Returns the SURF document of this configuration.
protected boolean	isEmptyInternal()
void	read(Reader in)
protected int	sizeInternal()
void	write(Writer out)

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, clearInternal, clearTree, clearTreeInternal, clone, containsKeyInternal, fetchNodeList, getExpressionEngine, getKeysInternal, getKeysInternal, getMaxIndex, getMaxIndexInternal, getModel, getRootElementName, getRootElementNameInternal, nodeDefined, nodeKey, resolveAddKey, resolveKey, resolveNodeKey, resolveUpdateKey, setExpressionEngine, setPropertyInternal

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, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getKeys, 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, toString, wait, wait, wait

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

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

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, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInt, getInt, getInteger, 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 Detail

SurfConfiguration

public SurfConfiguration()

Method Detail

read

public void read(@Nonnull
                 Reader in)
          throws org.apache.commons.configuration2.ex.ConfigurationException,
                 IOException

If an empty file is provided to the FileHandler, then we create the root object using as the type name.

Specified by:

read in interface org.apache.commons.configuration2.io.FileBased

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - if the root element is not an instance of SurfObject or if the Reader provided refers to a non-existing file.

IOException

write

public void write(@Nonnull
                  Writer out)
           throws org.apache.commons.configuration2.ex.ConfigurationException,
                  IOException

Specified by:

write in interface org.apache.commons.configuration2.io.FileBased

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

IOException

getPropertyInternal

protected Object getPropertyInternal(@Nonnull
                                     String key)

Overrides:

getPropertyInternal in class org.apache.commons.configuration2.AbstractHierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>

addPropertyInternal

protected void addPropertyInternal(@Nonnull
                                   String key,
                                   @Nullable
                                   Object obj)

Overrides:

addPropertyInternal in class org.apache.commons.configuration2.AbstractHierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>

clearPropertyDirect

protected void clearPropertyDirect(String key)

Overrides:

clearPropertyDirect in class org.apache.commons.configuration2.AbstractHierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>

isEmptyInternal

protected boolean isEmptyInternal()

Overrides:

isEmptyInternal in class org.apache.commons.configuration2.AbstractHierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>

sizeInternal

protected int sizeInternal()

Overrides:

sizeInternal in class org.apache.commons.configuration2.AbstractHierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>

getSurfDocument

public io.urf.surf.parser.SurfObject getSurfDocument()

Returns the SURF document of this configuration.

Returns:

The SURF document this configuration or null if it wasn't loaded from a file.