Author: oheger
Date: Sat Sep 13 15:47:43 2014
New Revision: 1624757
URL: http://svn.apache.org/r1624757
Log:
Enhanced Javadoc for interfaces not intended to be implemented.
Added a corresponding warning that these interfaces may change even in minor
releases.
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/BasicBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/HierarchicalBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/JndiBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/PropertiesBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/MultiFileBuilderProperties.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/CombinedBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/DatabaseBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/FileBasedBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/HierarchicalBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/JndiBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/MultiFileBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/PropertiesBuilderParameters.java
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/XMLBuilderParameters.java
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/BasicBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/BasicBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/BasicBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/BasicBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -39,6 +39,11 @@ import org.apache.commons.logging.Log;
* object. Properties can be set using a fluent API making it convenient for
* client code to specify concrete property values in a single statement.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/DatabaseBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -30,6 +30,11 @@ import javax.sql.DataSource;
* mandatory; they must be provided, otherwise the builder for database
* configurations throws an exception.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/HierarchicalBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/HierarchicalBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/HierarchicalBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/HierarchicalBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -26,6 +26,11 @@ import org.apache.commons.configuration2
* This interface defines set methods for additional properties common to all
* hierarchical configurations.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/JndiBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/JndiBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/JndiBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/JndiBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -26,6 +26,11 @@ import javax.naming.Context;
* This interface defines properties related to the JNDI tree to be represented
* by a {@code JNDIConfiguration}.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/PropertiesBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/PropertiesBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/PropertiesBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/PropertiesBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -27,6 +27,11 @@ import org.apache.commons.configuration2
* This interface defines additional properties which can be set when
* initializing a {@code PropertiesConfiguration} object.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -28,6 +28,11 @@ import org.xml.sax.EntityResolver;
* The {@code XMLConfiguration} class defines a bunch of additional properties
* related to XML processing.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -32,6 +32,11 @@ import org.apache.commons.configuration2
* of a combined configuration based on a definition configuration. Properties
* can be set in a fluent style.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/MultiFileBuilderProperties.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/MultiFileBuilderProperties.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/MultiFileBuilderProperties.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/combined/MultiFileBuilderProperties.java
Sat Sep 13 15:47:43 2014
@@ -28,6 +28,11 @@ import org.apache.commons.configuration2
* managing multiple file-based configurations which are selected by a pattern.
* Properties can be set in a fluent style.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id $
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/CombinedBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/CombinedBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/CombinedBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/CombinedBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -25,6 +25,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties of a builder for a combined configuration.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/DatabaseBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/DatabaseBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/DatabaseBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/DatabaseBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -25,6 +25,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties for a database configuration.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/FileBasedBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/FileBasedBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/FileBasedBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/FileBasedBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -25,6 +25,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties of a configuration of a file-based configuration builder.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/HierarchicalBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/HierarchicalBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/HierarchicalBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/HierarchicalBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -26,6 +26,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties for a hierarchical configuration.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/JndiBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/JndiBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/JndiBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/JndiBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -25,6 +25,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties for a JNDI configuration.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/MultiFileBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/MultiFileBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/MultiFileBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/MultiFileBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -25,6 +25,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties of a builder managing multiple file-based configurations.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/PropertiesBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/PropertiesBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/PropertiesBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/PropertiesBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -26,6 +26,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties for a properties configuration.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/XMLBuilderParameters.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/XMLBuilderParameters.java?rev=1624757&r1=1624756&r2=1624757&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/XMLBuilderParameters.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/builder/fluent/XMLBuilderParameters.java
Sat Sep 13 15:47:43 2014
@@ -27,6 +27,11 @@ import org.apache.commons.configuration2
* Definition of a parameters interface providing a fluent API for setting all
* properties for a XML configuration.
* </p>
+ * <p>
+ * <strong>Important note:</strong> This interface is not intended to be
+ * implemented by client code! It defines a set of available properties and may
+ * be extended even in minor releases.
+ * </p>
*
* @version $Id$
* @since 2.0