Title: [2190] branches/v-1.4.x: Merge javadoc update from HEAD.
Revision
2190
Author
joehni
Date
2013-12-21 11:37:07 -0600 (Sat, 21 Dec 2013)

Log Message

Merge javadoc update from HEAD.

Modified Paths


Property Changed

Diff

Property changes: branches/v-1.4.x


Modified: svn:mergeinfo

+ /trunk:2151-2152,2154-2156,2158-2163,2165,2172,2175,2177,2189

Modified: branches/v-1.4.x/xstream/src/java/com/thoughtworks/xstream/io/xml/PrettyPrintWriter.java (2189 => 2190)


--- branches/v-1.4.x/xstream/src/java/com/thoughtworks/xstream/io/xml/PrettyPrintWriter.java	2013-12-21 17:28:57 UTC (rev 2189)
+++ branches/v-1.4.x/xstream/src/java/com/thoughtworks/xstream/io/xml/PrettyPrintWriter.java	2013-12-21 17:37:07 UTC (rev 2190)
@@ -28,6 +28,11 @@
  * {@link #writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter, String)} methods.
  * </p>
  * <p>
+ * The XML specification requires XML parsers to drop CR characters completely. This implementation
+ * will therefore use only a LF for line endings, never the platform encoding. You can overwrite the
+ * {@link #getNewLine()} method for a different behavior. 
+ * </p>
+ * <p>
  * Note: Depending on the XML version some characters cannot be written. Especially a 0
  * character is never valid in XML, neither directly nor as entity nor within CDATA. However, this writer
  * works by default in a quirks mode, where it will write any character at least as character entity (even
@@ -345,6 +350,15 @@
         writer.close();
     }
 
+    /**
+     * Retrieve the line terminator.
+     * 
+     * This method returns always a line feed, since according the XML specification any parser
+     * must ignore a carriage return. Overload this method, if you need different behavior. 
+     * 
+     * @return the line terminator
+     * @since 1.3
+     */
     protected String getNewLine() {
         return newLine;
     }

To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to