Author: oheger
Date: Fri Oct 3 15:43:04 2014
New Revision: 1629233
URL: http://svn.apache.org/r1629233
Log:
[CONFIGURATION-592] Adapted links to API docs.
Links referencing Javadocs from the 1.10 user's guide have to be adapted to the
new site structure.
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_beans.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_events.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filebased.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_properties.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_utilities.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_xml.xml
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/overview.xml
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
Fri Oct 3 15:43:04 2014
@@ -28,7 +28,7 @@
<p>
The <code>Configuration</code> interface defines a whole bunch of
methods.
Implementing these methods all from scratch can be quite hard. Because of
- that the <code><a
href="../apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
+ that the <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
AbstractConfiguration</a></code> class exists. This class serves as a
common base class for most of the <code>Configuration</code>
implementations
in <em>Commons Configuration</em> and provides a great deal of the
@@ -256,7 +256,7 @@ public class EchoLookup extends StrLooku
Now we want this class to be called for variables with the prefix
<code>echo</code>. For this purpose the <code>EchoLookup</code> class
has to be registered at the
- <code><a
href="../apidocs/org/apache/commons/configuration/interpol/ConfigurationInterpolator.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/interpol/ConfigurationInterpolator.html">
ConfigurationInterpolator</a></code> class with the desired prefix.
<code>ConfigurationInterpolator</code> implements a thin wrapper over the
<code>StrLookup</code> API defined by Commons Lang. It has a static
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_beans.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_beans.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_beans.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_beans.xml
Fri Oct 3 15:43:04 2014
@@ -74,17 +74,17 @@
On the Java side three entities are involved in the creation of a bean:
<ul>
<li>A <em>bean factory</em>: This is an object that implements the
- <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/BeanFactory.html">BeanFactory</a></code>
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanFactory.html">BeanFactory</a></code>
interface and knows how to create an instance of a bean class. In
most
cases calling code does not directly deal with a bean factory.</li>
<li>An implementation of the
- <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/BeanDeclaration.html">BeanDeclaration</a></code>
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanDeclaration.html">BeanDeclaration</a></code>
interface. This object knows how the bean declaration in the
configuration
file is organized and how the needed information can be extracted. So
the way the bean is declared in the configuration file must match the
expectations of this object.</li>
<li>The utility class
- <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/BeanHelper.html">BeanHelper</a></code>
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanHelper.html">BeanHelper</a></code>
brings all these together and performs the bean creation operation.
Usually client code will create a <code>BeanDeclaration</code> object
from a <code>Configuration</code> implementation and then pass it to
@@ -188,10 +188,10 @@ WindowManager wm = (WindowManager) BeanH
<p>
This fragment loads the configuration file using a
<code>XMLConfiguration</code>
object. Then a bean declaration object is created, in this case an
- instance of the <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html">XMLBeanDeclaration</a></code>
+ instance of the <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/XMLBeanDeclaration.html">XMLBeanDeclaration</a></code>
class, which can deal with bean declarations in XML documents. This
declaration is passed to the static <code>createBean()</code> method of
- the <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/BeanHelper.html">BeanHelper</a></code>
+ the <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanHelper.html">BeanHelper</a></code>
class, which returns the new bean instance.
</p>
<p>
@@ -221,7 +221,7 @@ WindowManager wm = (WindowManager) BeanH
than the ones supported by the available default implementations. Then
it
is the responsibility of your implementation to parse the configuration
data and extract the required information to create the bean. Basically
- your <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/BeanDeclaration.html">BeanDeclaration</a></code>
+ your <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanDeclaration.html">BeanDeclaration</a></code>
implementation must be able to provide the following data:
<ul>
<li>The name of the class for which an instance is to be
created.</li>
@@ -248,7 +248,7 @@ WindowManager wm = (WindowManager) BeanH
allows you to adapt the format of bean declarations in configuration
files,
you can manipulate the bean creation mechanism itself by creating a
specialized implementation of the
- <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/BeanFactory.html">BeanFactory</a></code>
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanFactory.html">BeanFactory</a></code>
interface. For this purpose the following steps are necessary:
<ol>
<li>Create a class implementing the <code>BeanFactory</code>
interface.
@@ -270,7 +270,7 @@ WindowManager wm = (WindowManager) BeanH
<p>
We start with the creation of the factory class. The basic idea is that
the functionality for creating and initializing beans is already
provided
- by the <code><a
href="../apidocs/org/apache/commons/configuration/beanutils/DefaultBeanFactory.html">DefaultBeanFactory</a></code>
+ by the <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/DefaultBeanFactory.html">DefaultBeanFactory</a></code>
class, so we extend this class. Our implementation only has to deal
with
the singleton stuff: We keep a map that stores already created bean
instances and can be accessed by the name of their classes. In the
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
Fri Oct 3 15:43:04 2014
@@ -26,7 +26,7 @@
<body>
<section name="Combined Configuration">
<p>
- The <code><a
href="../apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
+ The <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
CombinedConfiguration</a></code> class provides an alternative for
handling
multiple configuration sources. Its API is very similar to the
<code>CompositeConfiguration</code> class, which was discussed in the
@@ -80,15 +80,15 @@
<subsection name="Node combiners">
<p>
A <em>node combiner</em> is an object of a class that inherits from the
- abstract <code><a
href="../apidocs/org/apache/commons/configuration/tree/NodeCombiner.html">NodeCombiner</a></code>
+ abstract <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/NodeCombiner.html">NodeCombiner</a></code>
class. This class defines an abstract <code>combine()</code> method,
which
takes the root nodes of two hierarchical configurations and returns the
root node of the combined node structure. It is up to a concrete
implementation how this combined structure will look like. Commons
Configuration ships with three concrete implementations
- <code><a
href="../apidocs/org/apache/commons/configuration/tree/OverrideCombiner.html">OverrideCombiner</a></code>,
- <code><a
href="../apidocs/org/apache/commons/configuration/tree/MergeCombiner.html">MergeCombiner</a></code>
- and <code><a
href="../apidocs/org/apache/commons/configuration/tree/UnionCombiner.html">UnionCombiner</a></code>,
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/OverrideCombiner.html">OverrideCombiner</a></code>,
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/MergeCombiner.html">MergeCombiner</a></code>
+ and <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/UnionCombiner.html">UnionCombiner</a></code>,
which implement an override, merge, and union semantics respectively.
</p>
<p>
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
Fri Oct 3 15:43:04 2014
@@ -30,7 +30,7 @@
There are many use cases when you want to collect the properties
of several configuration sources and access them like a single
configuration object. One way to do that is using the
- <code><a
href="../apidocs/org/apache/commons/configuration/CompositeConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/CompositeConfiguration.html">
CompositeConfiguration</a></code> class.
</p>
<p>
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
Fri Oct 3 15:43:04 2014
@@ -27,7 +27,7 @@
<section name="Using DefaultConfigurationBuilder">
<p>
This section explains how a
- <code><a
href="../apidocs/org/apache/commons/configuration/DefaultConfigurationBuilder.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/DefaultConfigurationBuilder.html">
DefaultConfigurationBuilder</a></code>object is setup that provides
access to a collection of different configuration sources.
<code>DefaultConfigurationBuilder</code> is the option of choice for
@@ -482,7 +482,7 @@ Configuration config = builder.getConfig
<dt>ini</dt>
<dd>This tag can be used to include an ini file into the resulting
combined configuration. Behind the scenes an instance of
- <code><a
href="../apidocs/org/apache/commons/configuration/HierarchicalINIConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/HierarchicalINIConfiguration.html">
HierarchicalINIConfiguration</a></code> is used to load the ini
file.</dd>
<dt>env</dt>
<dd>With this tag direct access to environment properties can be
enabled.
@@ -736,7 +736,7 @@ Configuration config = builder.getConfig
configuration sources we have to set this flag so that this reloading
strategy can function properly. More details about this topic can be
found in the Javadocs for
- <code><a
href="../apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
CombinedConfiguration</a></code>. We also set some properties for the
configurations to be loaded; for instance we declare that one of the XML
configurations should be validated.
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_events.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_events.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_events.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_events.xml
Fri Oct 3 15:43:04 2014
@@ -27,7 +27,7 @@
<section name="Configuration Events">
<p>
All configuration classes derived from
- <code><a
href="../apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
AbstractConfiguration</a></code> allow to register event listeners, which
are notified whenever the configuration's data is changed. This provides
an easy means for tracking updates on a configuration.
@@ -37,10 +37,10 @@
<p>
Objects that are interested in update events triggered by configurations
must implement the
- <code><a
href="../apidocs/org/apache/commons/configuration/event/ConfigurationListener.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/event/ConfigurationListener.html">
ConfigurationListener</a></code> interface. This interface defines a
single method <code>configurationChanged()</code>, which is passed a
- <code><a
href="../apidocs/org/apache/commons/configuration/event/ConfigurationEvent.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/event/ConfigurationEvent.html">
ConfigurationEvent</a></code> object. The event object contains all
information available about the modification, including:
<ul>
@@ -143,7 +143,7 @@ config.addProperty("newProperty", "newVa
Some implementations of the <code>Configuration</code> interface operate
on underlying storages that can throw exceptions on each property access.
As an example consider <code>
- <a
href="../apidocs/org/apache/commons/configuration/DatabaseConfiguration.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/DatabaseConfiguration.html">
DatabaseConfiguration</a></code>: this configuration class issues an SQL
statement for each accessed property, which can potentially cause a
<code>SQLException</code>.
@@ -159,11 +159,11 @@ config.addProperty("newProperty", "newVa
A configuration error listener is very similar to a regular configuration
event listener. Instead of the <code>ConfigurationListener</code>
interface it has to implement the
- <code><a
href="../apidocs/org/apache/commons/configuration/event/ConfigurationErrorListener.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/event/ConfigurationErrorListener.html">
ConfigurationErrorListener</a></code> interface, which defines a single
method
<code>configurationError()</code>. In case of an internal error this
method is invoked, and a
- <code><a
href="../apidocs/org/apache/commons/configuration/event/ConfigurationErrorEvent.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/event/ConfigurationErrorEvent.html">
ConfigurationErrorEvent</a></code> with information about that error is
passed. By inheriting from <code>ConfigurationEvent</code>
<code>ConfigurationErrorEvent</code> supports all information that is
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filebased.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filebased.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filebased.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filebased.xml
Fri Oct 3 15:43:04 2014
@@ -35,7 +35,7 @@
</p>
<p>
To provide a consistent way of dealing with configuration files in
- Commons Configuration the <code><a
href="../apidocs/org/apache/commons/configuration/FileConfiguration.html">FileConfiguration</a></code>
+ Commons Configuration the <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/FileConfiguration.html">FileConfiguration</a></code>
interface exists. <code>FileConfiguration</code> defines a standard
API for accessing files and is implemented by many configuration
implementations, including <code>PropertiesConfiguration</code> and
@@ -178,7 +178,7 @@ config.setProperty("colors.background",
concept of so called <em>reloading strategies</em> that can be
associated with a file-based configuration. Such a strategy monitors
a configuration file and is able to detect changes. A default
reloading
- strategy is <code><a
href="../apidocs/org/apache/commons/configuration/reloading/FileChangedReloadingStrategy.html">FileChangedReloadingStrategy</a></code>.
+ strategy is <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/reloading/FileChangedReloadingStrategy.html">FileChangedReloadingStrategy</a></code>.
It can be set on a file-based configuration as follows:
</p>
<source>
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filesystems.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
Fri Oct 3 15:43:04 2014
@@ -95,7 +95,7 @@
</subsection>
<subsection name="File Reloading Strategy">
<p>
- The <code><a
href="../apidocs/org/apache/commons/configuration/reloading/VFSFileChangedReloadingStrategy.html">VFSFileChangedReloadingStrategy</a></code>
+ The <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/reloading/VFSFileChangedReloadingStrategy.html">VFSFileChangedReloadingStrategy</a></code>
can be used to cause Configurations accessed via the
<code>VFSFileSystem</code> to be
monitored and reloaded when the files are modified. The example
below shows how
<code>DefaultConfigurationBuilder</code> can be configured to use
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_properties.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_properties.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_properties.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_properties.xml
Fri Oct 3 15:43:04 2014
@@ -30,14 +30,14 @@
Properties files are a popular mean of configuring applications. Of
course Commons Configuration
supports this format and enhances significantly the basic
<code>java.util.Properties</code> class.
This section introduces the features of the
- <code><a
href="../apidocs/org/apache/commons/configuration/PropertiesConfiguration.html">PropertiesConfiguration</a></code>
class.
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/PropertiesConfiguration.html">PropertiesConfiguration</a></code>
class.
Note that <code>PropertiesConfiguration</code> is a very typical
example
for an implementation of the <code>Configuration</code> interface and
many of the features described in this section (e.g. list handling or
interpolation) are supported by other configuration classes as well.
This is because most configuration implementations that ship with
Commons Configuration are derived from the common base class
- <code><a
href="../apidocs/org/apache/commons/configuration/AbstractConfiguration.html">AbstractConfiguration</a></code>,
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/AbstractConfiguration.html">AbstractConfiguration</a></code>,
which implements these features.
</p>
@@ -257,7 +257,7 @@ config.dirs = \\\\share2
<p>
Each <code>PropertiesConfiguration</code> object is associated with a
<em>Layout object</em>, an instance of the class
- <code><a
href="../apidocs/org/apache/commons/configuration/PropertiesConfigurationLayout.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/PropertiesConfigurationLayout.html">
PropertiesConfigurationLayout</a></code>. This layout object is
responsible for preserving most of the structure of loaded
configuration
files. This means that things like comments or blank lines in a saved
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_utilities.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_utilities.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_utilities.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_utilities.xml
Fri Oct 3 15:43:04 2014
@@ -37,7 +37,7 @@
<p>
Often it is required to copy the data of one <code>Configuration</code>
object into another one. For this purpose the
- <code><a
href="../apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
AbstractConfiguration</a></code> class (which serves as the base class
for
most of the configuration implementations shipped with this library)
provides two methods implementing a basic copy operation:
@@ -64,7 +64,7 @@
configurations. Most of the configuration implementations provided by
<em>Commons Configurations</em> support cloning. The
<code>cloneConfiguration()</code> method of
- <code><a
href="../apidocs/org/apache/commons/configuration/ConfigurationUtils.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/ConfigurationUtils.html">
ConfigurationUtils</a></code> can be used for creating a copy of an
arbitrary <code>Configuration</code> object. This method checks whether
the passed in configuration implements the <code>Cloneable</code>
@@ -95,7 +95,7 @@ HierarchicalConfiguration hc =
]]></source>
<p>
The <code>convertToHierarchical()</code> method of
- <code><a
href="../apidocs/org/apache/commons/configuration/ConfigurationUtils.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/ConfigurationUtils.html">
ConfigurationUtils</a></code> checks whether the passed in object
is already a hierarchical configuration. If this is the case, it is
returned unchanged. Otherwise a new
<code>HierarchicalConfiguration</code>
@@ -159,7 +159,7 @@ HierarchicalConfiguration hc =
be the requirement of converting from <code>Properties</code> objects to
<code>Configuration</code> objects and vice versa. For this purpose an
utility class can be used:
- <code><a
href="../apidocs/org/apache/commons/configuration/ConfigurationConverter.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/ConfigurationConverter.html">
ConfigurationConverter</a></code>.
</p>
<p>
@@ -192,7 +192,7 @@ Properties processConfiguration(Properti
]]></source>
<p>
Please refer to the Javadocs of
- <code><a
href="../apidocs/org/apache/commons/configuration/ConfigurationConverter.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/ConfigurationConverter.html">
ConfigurationConverter</a></code> to learn more about the available
conversion methods and their limitations.
</p>
@@ -211,7 +211,7 @@ Properties processConfiguration(Properti
written by <em>Commons Configuration</em>.
</p>
<p>
- <code><a
href="../apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/AbstractConfiguration.html">
AbstractConfiguration</a></code> provides the method
<code>interpolatedConfiguration()</code>. This method creates a clone of
the current configuration and then performs interpolation on all of its
@@ -219,7 +219,7 @@ Properties processConfiguration(Properti
basically the same content as the original configuration, but with all
variables replaced by their actual values (as far as this was possible).
The following code fragment shows how a
- <code><a
href="../apidocs/org/apache/commons/configuration/PropertiesConfiguration.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/PropertiesConfiguration.html">
PropertiesConfiguration</a></code> object can be saved in a way that the
resulting properties file does not contain any variables:
</p>
@@ -244,11 +244,11 @@ extConfig.save("external_config.properti
you do not want to provide a special error handler, but only need to
propagate the exception that caused the error event, you can make use of
a convenience method of the
- <code><a
href="../apidocs/org/apache/commons/configuration/ConfigurationUtils.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/ConfigurationUtils.html">
ConfigurationUtils</a></code> class:
<code>enableRuntimeExceptions()</code>
registers a special error listener at the passed in configuration that
will throw a
- <code><a
href="../apidocs/org/apache/commons/configuration/ConfigurationRuntimeException.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/ConfigurationRuntimeException.html">
ConfigurationRuntimeException</a></code> exception for each received
error event. The following code fragment shows an example of using this
method:
@@ -263,7 +263,7 @@ String value = config.getString("myKey")
<p>
<code>enableRuntimeExceptions()</code> can be called for all
<code>Configuration</code> implementations that are derived from
- <code><a
href="../apidocs/org/apache/commons/configuration/event/EventSource.html">
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/event/EventSource.html">
EventSource</a></code> (which is the case for almost all configuration
classes provided by this library). Of course the affected implementation
must support the mechanism of error events, otherwise the registered
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_xml.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_xml.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_xml.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/howto_xml.xml
Fri Oct 3 15:43:04 2014
@@ -36,13 +36,13 @@
Many sources of configuration data have a hierarchical or tree-like
nature. They can represent data that is structured in many ways.
Such configuration sources are represented by classes derived from
- <a
href="../apidocs/org/apache/commons/configuration/HierarchicalConfiguration.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/HierarchicalConfiguration.html">
<code>HierarchicalConfiguration</code></a>.
</p>
<p>
Prominent examples of hierarchical configuration sources are XML
documents. They can be read and written using the
- <a
href="../apidocs/org/apache/commons/configuration/XMLConfiguration.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/XMLConfiguration.html">
<code>XMLConfiguration</code></a> class. This section explains how
to deal with such structured data and demonstrates the enhanced
query
facilities supported by <code>HierarchicalConfiguration</code>. We
@@ -51,11 +51,11 @@
properties) applies to other hierarchical configurations as well.
Examples for other hierarchical configuration classes are
<ul>
- <li><a
href="../apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
+ <li><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
<code>CombinedConfiguration</code></a></li>
- <li><a
href="../apidocs/org/apache/commons/configuration/HierarchicalINIConfiguration.html">
+ <li><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/HierarchicalINIConfiguration.html">
<code>HierarchicalINIConfiguration</code></a></li>
- <li><a
href="../apidocs/org/apache/commons/configuration/plist/PropertyListConfiguration.html">
+ <li><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/plist/PropertyListConfiguration.html">
<code>PropertyListConfiguration</code></a></li>
</ul>
</p>
@@ -417,7 +417,7 @@ for(HierarchicalConfiguration sub : fiel
<p>
The configurations returned by the <code>configurationAt()</code> and
<code>configurationsAt()</code> method are in fact instances of the
- <a
href="../apidocs/org/apache/commons/configuration/SubnodeConfiguration.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/SubnodeConfiguration.html">
<code>SubnodeConfiguration</code></a> class. The API documentation of
this class contains more information about its features and
limitations.
@@ -689,7 +689,7 @@ config.load("config.xml");
becomes possible to plug in different expression engines into a
<code>HierarchicalConfiguration</code> object. So by providing
different implementations of the
- <a
href="../apidocs/org/apache/commons/configuration/tree/ExpressionEngine.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/ExpressionEngine.html">
<code>ExpressionEngine</code></a>
interface hierarchical configurations can support alternative
expression languages for accessing their data.
@@ -698,7 +698,7 @@ config.load("config.xml");
Before we discuss the available expression engines that ship
with Commons Configuration, it should be explained how an
expression engine can be associated with a configuration object.
- <a
href="../apidocs/org/apache/commons/configuration/HierarchicalConfiguration.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/HierarchicalConfiguration.html">
<code>HierarchicalConfiguration</code></a> and all derived classes
provide a <code>setExpressionEngine()</code> method, which expects
an implementation of the <code>ExpressionEngine</code> interface as
@@ -726,9 +726,9 @@ config.load("config.xml");
<p>
The syntax described so far for property keys of hierarchical
configurations is implemented by a specific implementation of
the
- <a
href="../apidocs/org/apache/commons/configuration/tree/ExpressionEngine.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/ExpressionEngine.html">
<code>ExpressionEngine</code></a> interface called
- <a
href="../apidocs/org/apache/commons/configuration/tree/DefaultExpressionEngine.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/DefaultExpressionEngine.html">
<code>DefaultExpressionEngine</code></a>. An instance of this
class
is installed as the global expression engine in
<code>HierarchicalConfiguration</code>. So all newly created
@@ -832,7 +832,7 @@ Object value = config.getProperty("table
</p>
<p>
For enabling XPATH syntax for property keys you need the
- <a
href="../apidocs/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.html">
<code>XPathExpressionEngine</code></a> class. This class
implements the <code>ExpressionEngine</code> interface and can
be plugged into a <code>HierarchicalConfiguration</code> object
@@ -959,7 +959,7 @@ config.addProperty("tables table/name",
the <code><tables></code> element. More information
about
keys and how they play together with <code>addProperty()</code>
and <code>setProperty()</code> can be found in the Javadocs for
- <a
href="../apidocs/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.html">
+ <a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.html">
<code>XPathExpressionEngine</code></a>.
</p>
<p>
Modified:
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/overview.xml
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/overview.xml?rev=1629233&r1=1629232&r2=1629233&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/overview.xml
(original)
+++
commons/proper/configuration/trunk/src/site/xdoc/userguide_v1.10/overview.xml
Fri Oct 3 15:43:04 2014
@@ -29,7 +29,7 @@
Commons Configuration allows you to access configuration properties
from
a variety of different sources. No matter if they are stored in a
properties file,
a XML document, or a JNDI tree, they can all be accessed in the same
way
- through the generic <code><a
href="../apidocs/org/apache/commons/configuration/Configuration.html">Configuration</a></code>
+ through the generic <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/Configuration.html">Configuration</a></code>
interface.
</p>
<p>
@@ -140,7 +140,7 @@ Configuration config = factory.getConfig
<p>
All the classes in this package that represent different kinds of
configuration
sources share a single interface:
- <code><a
href="../apidocs/org/apache/commons/configuration/Configuration.html">Configuration</a></code>.
+ <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/Configuration.html">Configuration</a></code>.
This interface allows you to access and manipulate configuration
properties
in a generic way.
</p>
