commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nia...@apache.org
Subject svn commit: r611634 - /commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
Date Sun, 13 Jan 2008 20:35:02 GMT
Author: niallp
Date: Sun Jan 13 12:35:00 2008
New Revision: 611634

URL: http://svn.apache.org/viewvc?rev=611634&view=rev
Log:
Correct JavaDoc - encoding must be specified

Modified:
    commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java

Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java?rev=611634&r1=611633&r2=611634&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
(original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
Sun Jan 13 12:35:00 2008
@@ -36,7 +36,13 @@
  * <code>FileWriter</code>.
  * <p>
  * By default, the file will be overwritten, but this may be changed to append.
- * The encoding may also be specified, and defaults to the platform default.
+ * <p>
+ * The encoding must be specified using either the name of the {@link Charset},
+ * the {@link Charset}, or a {@link CharsetEncoder}. If the default encoding
+ * is required then use the {@link java.io.FileWriter} directly, rather than
+ * this implementation.
+ * <p>
+ * 
  *
  * @since Commons IO 1.4
  * @version $Id$



Mime
View raw message