Author: oheger
Date: Thu Dec 1 20:51:46 2016
New Revision: 1772264
URL: http://svn.apache.org/viewvc?rev=1772264&view=rev
Log:
[CONFIGURATION-641] Added a warning to FileBased Javadocs.
The methods defined by this interface should not be called directly
by client code, but only via a FileHandler object.
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/io/FileBased.java
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/io/FileBased.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/io/FileBased.java?rev=1772264&r1=1772263&r2=1772264&view=diff
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/io/FileBased.java
(original)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/io/FileBased.java
Thu Dec 1 20:51:46 2016
@@ -34,6 +34,15 @@ import org.apache.commons.configuration2
* these methods it is possible to implement other methods which operate on
* files, file names, URLs, etc.
* </p>
+ * <p>
+ * <strong>Note that the methods defined by this interface are not intended to
+ * be called directly by client code!</strong> Rather, they are used internally
+ * when doing I/O operations with a {@link FileHandler}. A {@code FileHandler}
+ * supports additional functionality (e.g. it evaluates some additional
+ * interfaces the {@code FileBased} object may implement); this functionality
+ * is not available on a direct method invocation, so this may lead to
+ * unpredictable results.
+ * </p>
*
* @version $Id$
*/
@@ -41,6 +50,8 @@ public interface FileBased
{
/**
* Reads the content of this object from the given reader.
+ * <strong>Client code should not call this method directly, but use a
+ * {@code FileHandler} for reading data.</strong>
*
* @param in the reader
* @throws IOException if an I/O error occurs
@@ -51,6 +62,8 @@ public interface FileBased
/**
* Writes the content of this object to the given writer.
+ * <strong>Client code should not call this method directly, but use a
+ * {@code FileHandler} for writing data.</strong>
*
* @param out the writer
* @throws IOException if an I/O error occurs
