svn commit: r1726356 - in /webservices/axiom/trunk: axiom-api/src/main/java/org/apache/axiom/om/impl/builder/ src/site/apt/ src/site/markdown/release-notes/

[ve...@apache.org]

Author: veithen
Date: Sat Jan 23 08:17:47 2016
New Revision: 1726356

URL: http://svn.apache.org/viewvc?rev=1726356&view=rev
Log:
Remove the BuilderAwareReader API introduced by AXIOM-268.

Removed:
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/BuilderAwareReader.java
Modified:
    webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java
    webservices/axiom/trunk/src/site/apt/roadmap.apt
    webservices/axiom/trunk/src/site/markdown/release-notes/1.3.0.md

Modified: webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java?rev=1726356&r1=1726355&r2=1726356&view=diff
==============================================================================
--- webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java (original)
+++ webservices/axiom/trunk/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java Sat Jan 23 08:17:47 2016
@@ -170,9 +170,6 @@ public class StAXOMBuilder implements OM
         this.detachable = detachable;
         this.closeable = closeable;
         charEncoding = encoding;
-        if (parser instanceof BuilderAwareReader) {
-            ((BuilderAwareReader) parser).setBuilder(this);
-        }
         dataHandlerReader = XMLStreamReaderUtils.getDataHandlerReader(parser);
         this.parser = parser;
     }

Modified: webservices/axiom/trunk/src/site/apt/roadmap.apt
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/src/site/apt/roadmap.apt?rev=1726356&r1=1726355&r2=1726356&view=diff
==============================================================================
--- webservices/axiom/trunk/src/site/apt/roadmap.apt (original)
+++ webservices/axiom/trunk/src/site/apt/roadmap.apt Sat Jan 23 08:17:47 2016
@@ -141,20 +141,6 @@ Removal of unnecessary or irrelevant API
    * The <<<XOPBuilder>>> interface extends <<<OMAttachmentAccessor>>>. However, as explained below,
      that API will be removed in Axiom 1.3.
 
-* <<<org.apache.axiom.om.impl.builder.BuilderAwareReader>>>
-
-  This API can't be preserved as is in Axiom 1.3. There are two reasons for this:
-  
-   * The only method defined by the <<<BuilderAwareReader>>> interface has a
-     parameter of type <<<StAXBuilder>>>, but that class will be removed from
-     <<<axiom-api>>> (see below). The parameter type would have to be changed to
-     <<<OMXMLParserWrapper>>>.
-   
-   * It the interface is considered a public API, then it is placed in the
-     wrong package.
-  
-  TODO: analyze the use cases for this API to see if we still need it 
-
 * <<<org.apache.axiom.om.impl.builder.XOPBuilder>>>
 
   The <<<XOPBuilder>>> interface is implemented by <<<XOPAwareStAXOMBuilder>>> and <<<MTOMStAXSOAPModelBuilder>>>.

Modified: webservices/axiom/trunk/src/site/markdown/release-notes/1.3.0.md
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/src/site/markdown/release-notes/1.3.0.md?rev=1726356&r1=1726355&r2=1726356&view=diff
==============================================================================
--- webservices/axiom/trunk/src/site/markdown/release-notes/1.3.0.md (original)
+++ webservices/axiom/trunk/src/site/markdown/release-notes/1.3.0.md Sat Jan 23 08:17:47 2016
@@ -20,4 +20,21 @@ Changes in this release
     should use the `OMXMLBuilderFactory` API to create builders. Code written for
     Axiom 1.2.x that uses that API remains compatible with Axiom 1.3.x.
 
+*   The `BuilderAwareReader` API introduced by [AXIOM-268][] has been removed
+    without replacement. There are multiple reasons for this:
+
+    *   The only method defined by the `BuilderAwareReader` interface has a
+        parameter of type `StAXBuilder`, but that class has been removed from
+        the public API (see above). The parameter type would have to be changed
+        to `OMXMLParserWrapper`.
+    *   If the interface is considered a public API, then it is placed in the
+        wrong package (`org.apache.axiom.om.impl.builder`).
+    *   There are no known usages of that API.
+    *   The API is merely a convenience, but doesn't provide any additional
+        feature: since a builder only starts consuming the `XMLStreamReader` on
+        demand, a reference to the builder can be injected into the custom
+        "builder aware" reader after the builder has been created.
+
+[AXIOM-268]: https://issues.apache.org/jira/browse/AXIOM-268
+
 *   Some (most? all?) of the classes in `axiom-compat` have been removed.