svn commit: r725422 - in /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om: OMDataSource.java OMDataSourceExt.java

[veithen]

Author: veithen
Date: Wed Dec 10 12:37:37 2008
New Revision: 725422

URL: http://svn.apache.org/viewvc?rev=725422&view=rev
Log:
WSCOMMONS-336: Clarify specification of OMDataSource#serialize(OutputStream, 
OMOutputFormat) based on behavior of existing implementations (that assume that 
format != null) and using common sense (an implementation must at least take 
into account the charset encoding!).

Modified:
    
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSource.java
    
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSourceExt.java

Modified: 
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSource.java
URL: 
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSource.java?rev=725422&r1=725421&r2=725422&view=diff
==============================================================================
--- 
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSource.java
 (original)
+++ 
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSource.java
 Wed Dec 10 12:37:37 2008
@@ -37,8 +37,9 @@
      * Serializes element data directly to stream.
      *
      * @param output destination stream for element XML text
-     * @param format output format information (<code>null</code> if none; may 
be ignored if not
-     *               supported by data binding even if supplied)
+     * @param format Output format information. The implementation must use 
this information
+     *               to choose the correct character set encoding when writing 
to the
+     *               output stream. This parameter must not be null.
      * @throws XMLStreamException
      */
     void serialize(OutputStream output, OMOutputFormat format)

Modified: 
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSourceExt.java
URL: 
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSourceExt.java?rev=725422&r1=725421&r2=725422&view=diff
==============================================================================
--- 
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSourceExt.java
 (original)
+++ 
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMDataSourceExt.java
 Wed Dec 10 12:37:37 2008
@@ -57,8 +57,9 @@
      * @see OMDataSourceExt
      *
      * @param output destination stream for element XML text
-     * @param format output format information (<code>null</code> if none; may
-     * be ignored if not supported by data binding even if supplied)
+     * @param format Output format information. The implementation must use 
this information
+     *               to choose the correct character set encoding when writing 
to the
+     *               output stream. This parameter must not be null.
      * @throws XMLStreamException
      */
     public void serialize(OutputStream output, OMOutputFormat format) throws 
XMLStreamException;