Using Stax2 (Woodstox) instead of plexus-xml (Xpp) to process XML doc…

…uments; reimplemented the mutable reader using an XMLStreamReader2, added some cleanup and more documentation. (#1174)
mojohaus · Nov 5, 2024 · a899699 · a899699
1 parent 8f48640
commit a899699
Show file tree

Hide file tree

Showing 54 changed files with 1,262 additions and 1,580 deletions.
diff --git a/pom.xml b/pom.xml
@@ -123,6 +123,8 @@
     <doxiaVersion>1.12.0</doxiaVersion>
     <doxia-sitetoolsVersion>1.11.1</doxia-sitetoolsVersion>
     <mockitoVersion>4.11.0</mockitoVersion>
+    <woodstoxVersion>7.1.0</woodstoxVersion>
+    <stax2ApiVersion>4.2.2</stax2ApiVersion>
 
     <!-- dotted property can not be used in .vm -->
     <pluginVersion>${project.version}</pluginVersion>
@@ -186,6 +188,16 @@
         <artifactId>maven-compat</artifactId>
         <version>${mavenVersion}</version>
       </dependency>
+      <dependency>
+        <groupId>com.fasterxml.woodstox</groupId>
+        <artifactId>woodstox-core</artifactId>
+        <version>${woodstoxVersion}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.codehaus.woodstox</groupId>
+        <artifactId>stax2-api</artifactId>
+        <version>${stax2ApiVersion}</version>
+      </dependency>
 
       <dependency>
         <groupId>org.apache.maven.resolver</groupId>
@@ -274,11 +286,6 @@
         <artifactId>plexus-interactivity-api</artifactId>
         <version>1.3</version>
       </dependency>
-      <dependency>
-        <groupId>com.fasterxml.woodstox</groupId>
-        <artifactId>woodstox-core</artifactId>
-        <version>7.1.0</version>
-      </dependency>
       <dependency>
         <groupId>org.apache.commons</groupId>
         <artifactId>commons-lang3</artifactId>

diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/api/PomHelper.java b/versions-common/src/main/java/org/codehaus/mojo/versions/api/PomHelper.java
diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/api/PropertyVersionsBuilder.java b/versions-common/src/main/java/org/codehaus/mojo/versions/api/PropertyVersionsBuilder.java
@@ -36,7 +36,7 @@
  * @author Stephen Connolly
  * @since 1.0-beta-1
  */
-class PropertyVersionsBuilder {
+public class PropertyVersionsBuilder {
     private final String name;
 
     private final String profileId;

diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/change/AbstractVersionChanger.java b/versions-common/src/main/java/org/codehaus/mojo/versions/change/AbstractVersionChanger.java
@@ -21,7 +21,7 @@
 
 import org.apache.maven.model.Model;
 import org.apache.maven.plugin.logging.Log;
-import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
 
 /**
  * Created by IntelliJ IDEA.
@@ -32,11 +32,11 @@
 public abstract class AbstractVersionChanger implements VersionChanger {
     private final Model model;
 
-    private final ModifiedPomXMLEventReader pom;
+    private final MutableXMLStreamReader pom;
 
     protected final Log log;
 
-    public AbstractVersionChanger(Model model, ModifiedPomXMLEventReader pom, Log log) {
+    public AbstractVersionChanger(Model model, MutableXMLStreamReader pom, Log log) {
         this.model = model;
         this.pom = pom;
         this.log = log;
@@ -46,7 +46,7 @@ public Model getModel() {
         return model;
     }
 
-    public ModifiedPomXMLEventReader getPom() {
+    public MutableXMLStreamReader getPom() {
         return pom;
     }
 

diff --git a/...ions-common/src/main/java/org/codehaus/mojo/versions/change/DependencyVersionChanger.java b/...ions-common/src/main/java/org/codehaus/mojo/versions/change/DependencyVersionChanger.java
@@ -21,7 +21,7 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.mojo.versions.api.PomHelper;
 import org.codehaus.mojo.versions.api.change.DependencyVersionChange;
-import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
 
 /**
  * Created by IntelliJ IDEA.
@@ -31,7 +31,7 @@
  */
 public class DependencyVersionChanger extends AbstractVersionChanger {
 
-    public DependencyVersionChanger(Model model, ModifiedPomXMLEventReader pom, Log reporter) {
+    public DependencyVersionChanger(Model model, MutableXMLStreamReader pom, Log reporter) {
         super(model, pom, reporter);
     }
 

diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/change/ParentVersionChanger.java b/versions-common/src/main/java/org/codehaus/mojo/versions/change/ParentVersionChanger.java
@@ -21,14 +21,14 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.mojo.versions.api.PomHelper;
 import org.codehaus.mojo.versions.api.change.DependencyVersionChange;
-import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
 
 /**
  *
  */
 public class ParentVersionChanger extends AbstractVersionChanger {
 
-    public ParentVersionChanger(Model model, ModifiedPomXMLEventReader pom, Log reporter) {
+    public ParentVersionChanger(Model model, MutableXMLStreamReader pom, Log reporter) {
         super(model, pom, reporter);
     }
 

diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/change/PluginVersionChanger.java b/versions-common/src/main/java/org/codehaus/mojo/versions/change/PluginVersionChanger.java
@@ -21,7 +21,7 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.mojo.versions.api.PomHelper;
 import org.codehaus.mojo.versions.api.change.DependencyVersionChange;
-import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
 
 /**
  * Created by IntelliJ IDEA.
@@ -31,7 +31,7 @@
  */
 public class PluginVersionChanger extends AbstractVersionChanger {
 
-    public PluginVersionChanger(Model model, ModifiedPomXMLEventReader pom, Log reporter) {
+    public PluginVersionChanger(Model model, MutableXMLStreamReader pom, Log reporter) {
         super(model, pom, reporter);
     }
 

diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/change/ProjectVersionChanger.java b/versions-common/src/main/java/org/codehaus/mojo/versions/change/ProjectVersionChanger.java
@@ -21,7 +21,7 @@
 import org.apache.maven.plugin.logging.Log;
 import org.codehaus.mojo.versions.api.PomHelper;
 import org.codehaus.mojo.versions.api.change.DependencyVersionChange;
-import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
 
 /**
  * Created by IntelliJ IDEA.
@@ -31,7 +31,7 @@
  */
 public class ProjectVersionChanger extends AbstractVersionChanger {
 
-    public ProjectVersionChanger(Model model, ModifiedPomXMLEventReader pom, Log reporter) {
+    public ProjectVersionChanger(Model model, MutableXMLStreamReader pom, Log reporter) {
         super(model, pom, reporter);
     }
 

diff --git a/versions-common/src/main/java/org/codehaus/mojo/versions/change/VersionChangerFactory.java b/versions-common/src/main/java/org/codehaus/mojo/versions/change/VersionChangerFactory.java
@@ -24,7 +24,7 @@
 
 import org.apache.maven.model.Model;
 import org.apache.maven.plugin.logging.Log;
-import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
+import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
 
 /**
  * Created by IntelliJ IDEA.
@@ -35,7 +35,7 @@
 public class VersionChangerFactory {
     private Model model = null;
 
-    private ModifiedPomXMLEventReader pom = null;
+    private MutableXMLStreamReader pom = null;
 
     private Log log = null;
 
@@ -47,11 +47,11 @@ public synchronized void setModel(Model model) {
         this.model = model;
     }
 
-    public synchronized ModifiedPomXMLEventReader getPom() {
+    public synchronized MutableXMLStreamReader getPom() {
         return pom;
     }
 
-    public synchronized void setPom(ModifiedPomXMLEventReader pom) {
+    public synchronized void setPom(MutableXMLStreamReader pom) {
         this.pom = pom;
     }