com.virtlink.commons.configuration2.jackson

Class JacksonConfiguration

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

com.virtlink.commons.configuration2.jackson.JacksonConfiguration

All Implemented Interfaces:

java.lang.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.io.FileLocatorAware, org.apache.commons.configuration2.io.InputStreamSupport, 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>

Direct Known Subclasses:

JsonConfiguration

public abstract class JacksonConfiguration
extends org.apache.commons.configuration2.BaseHierarchicalConfiguration
implements org.apache.commons.configuration2.FileBasedConfiguration, org.apache.commons.configuration2.io.InputStreamSupport, org.apache.commons.configuration2.io.FileLocatorAware

A configuration using a Jackson language (e.g. YAML, JSON).

Nested Class Summary

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

org.apache.commons.configuration2.BaseHierarchicalConfiguration.BuilderVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.configuration2.io.FileLocator	locator The FileLocator that may specify where the source/destination file is.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JacksonConfiguration(com.fasterxml.jackson.core.JsonFactory factory) Initializes a new instance of the JacksonConfiguration class.
protected	JacksonConfiguration(com.fasterxml.jackson.core.JsonFactory factory, org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config) Initializes a new instance of the JacksonConfiguration class.

Method Summary

Modifier and Type	Method and Description
void	initFileLocator(org.apache.commons.configuration2.io.FileLocator locator) Sets the file locator to use for the next invocation of read(InputStream) or write(Writer).
void	read(java.io.InputStream inputStream) Reads the configuration.
void	read(java.io.Reader reader) Reads the configuration.
void	write(java.io.Writer writer) Writes the configuration.

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, 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, 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, getDuration, getDuration, getEncodedString, getEncodedString, getEnum, getEnum, 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

Field Detail

locator

@Nullable
protected org.apache.commons.configuration2.io.FileLocator locator

The FileLocator that may specify where the source/destination file is.

This is for use by derived classses, if necessary.

Constructor Detail

JacksonConfiguration

protected JacksonConfiguration(com.fasterxml.jackson.core.JsonFactory factory)

Initializes a new instance of the JacksonConfiguration class.

Parameters:

factory - the Jackson factory to use

JacksonConfiguration

protected JacksonConfiguration(com.fasterxml.jackson.core.JsonFactory factory,
                               org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)

Initializes a new instance of the JacksonConfiguration class.

Parameters:

factory - the Jackson factory to use

config - the configuration whose nodes to copy into this configuration

Method Detail

read

public void read(java.io.InputStream inputStream)
          throws org.apache.commons.configuration2.ex.ConfigurationException,
                 java.io.IOException

Reads the configuration.

Specified by:

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

Parameters:

inputStream - the input stream to read from

Throws:

java.io.IOException - if an I/O error occurs

org.apache.commons.configuration2.ex.ConfigurationException - if a non-I/O related problem occurs

read

public void read(java.io.Reader reader)
          throws org.apache.commons.configuration2.ex.ConfigurationException,
                 java.io.IOException

Reads the configuration.

Specified by:

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

Parameters:

reader - the reader to read from

Throws:

java.io.IOException - if an I/O error occurs

org.apache.commons.configuration2.ex.ConfigurationException - if a non-I/O related problem occurs

write

public void write(java.io.Writer writer)
           throws org.apache.commons.configuration2.ex.ConfigurationException,
                  java.io.IOException

Writes the configuration.

Specified by:

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

Parameters:

writer - the writer to write to

Throws:

java.io.IOException - if an I/O error occurs

org.apache.commons.configuration2.ex.ConfigurationException - if a non-I/O related problem occurs

initFileLocator

public void initFileLocator(@Nullable
                            org.apache.commons.configuration2.io.FileLocator locator)

Sets the file locator to use for the next invocation of read(InputStream) or write(Writer).

Specified by:

initFileLocator in interface org.apache.commons.configuration2.io.FileLocatorAware

Parameters:

locator - the file locator to use; or null