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

[ve...@apache.org]

Author: veithen
Date: Sun May 20 11:23:17 2012
New Revision: 1340679

URL: http://svn.apache.org/viewvc?rev=1340679&view=rev
Log:
AXIOM-419: Clarify the contract of OMDataSourceExt#copy() and fixed the default implementation in AbstractOMDataSource accordingly.

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

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=1340679&r1=1340678&r2=1340679&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 Sun May 20 11:23:17 2012
@@ -96,8 +96,14 @@ public interface OMDataSourceExt extends
     void close();
     
     /**
-     * Create a copy of the OMDataSourceExt
-     * @return OMDataSourceExt
+     * Create a copy of the data source. This method is used by
+     * {@link OMElement#cloneOMElement(OMCloneOptions)} when the
+     * {@link OMCloneOptions#isCopyOMDataSources()} option is enabled. If the data source is
+     * immutable and stateless, then it may return a reference to itself instead of creating a new
+     * data source instance.
+     * 
+     * @return the copy of the data source, or <code>null</code> if the data source can't be copied
+     *         (e.g. because it is destructive)
      */
     OMDataSourceExt copy();
     

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractOMDataSource.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractOMDataSource.java?rev=1340679&r1=1340678&r2=1340679&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractOMDataSource.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/AbstractOMDataSource.java Sun May 20 11:23:17 2012
@@ -95,6 +95,6 @@ public abstract class AbstractOMDataSour
     }
 
     public OMDataSourceExt copy() {
-        throw new UnsupportedOperationException();
+        return null;
     }
 }