You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by ve...@apache.org on 2012/08/18 08:13:28 UTC

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

Author: veithen
Date: Sat Aug 18 06:13:28 2012
New Revision: 1374516

URL: http://svn.apache.org/viewvc?rev=1374516&view=rev
Log:
AXIOM-419: Deprecated OMDataSourceExtBase and added Javadoc to AbstractOMDataSource.

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

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=1374516&r1=1374515&r2=1374516&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 Sat Aug 18 06:13:28 2012
@@ -29,12 +29,19 @@ import java.util.HashMap;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import org.apache.axiom.om.OMDataSource;
 import org.apache.axiom.om.OMDataSourceExt;
 import org.apache.axiom.om.OMException;
 import org.apache.axiom.om.OMOutputFormat;
 import org.apache.axiom.om.impl.MTOMXMLStreamWriter;
 import org.apache.axiom.om.util.StAXUtils;
 
+/**
+ * Base class for {@link OMDataSourceExt} implementations. This class should only be used by data
+ * sources that can equally well produce an {@link XMLStreamReader} and have a meaningful
+ * implementation of {@link OMDataSource#serialize(XMLStreamWriter)}. Most implementations should
+ * actually use {@link AbstractPullOMDataSource} or {@link AbstractPushOMDataSource}.
+ */
 public abstract class AbstractOMDataSource implements OMDataSourceExt {
     private HashMap properties = null;
 

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/OMDataSourceExtBase.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/OMDataSourceExtBase.java?rev=1374516&r1=1374515&r2=1374516&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/OMDataSourceExtBase.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/ds/OMDataSourceExtBase.java Sat Aug 18 06:13:28 2012
@@ -43,6 +43,12 @@ import org.apache.commons.logging.LogFac
 /**
  * OMDataSourceExtBase is a convenient base class that can be extended
  * by other OMDataSourceExt implementations.
+ * 
+ * @deprecated As described in <a
+ *             href="https://issues.apache.org/jira/browse/AXIOM-419">AXIOM-419</a>, this class has
+ *             multiple issues and should no longer be used as a base class for {@link OMDataSource}
+ *             implementations. Instead, use {@link AbstractOMDataSource},
+ *             {@link AbstractPullOMDataSource} or {@link AbstractPushOMDataSource}.
  */
 public abstract class OMDataSourceExtBase implements OMDataSourceExt {