Merge branch '2.x' into 3.x

Author: cowtowncoder

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java_version: ['17', '21', '23' ]
+        java_version: ['17', '21', '24' ]
         include:
           - java_version: '17'
             release_build: 'R'

release-notes/CREDITS-2.x

@@ -276,3 +276,8 @@ Bas Passon (@bpasson)
 
 * Contributed #745: Add feature to include `standalone='yes'` in xml declaration
  (2.19.0)
+
+(@xzxiaoshan)
+* Contributed #768: `FromXmlParser` lacks extension point for passing
+  custom `XmlTokenStream`
+ (2.20.0)

release-notes/VERSION-2.x

@@ -6,9 +6,11 @@ Project: jackson-dataformat-xml
 
 2.20.0 (not yet released)
 
+#768: `FromXmlParser` lacks extension point for passing custom `XmlTokenStream`
+ (contributed by @xzxiaoshan)
 - Generate SBOMs [JSTEP-14]
 
-2.19.1 (not yet released)
+2.19.1 (13-Jun-2025)
 
 - Add explicit version for Woodstox, stax2-api (no longer managed via jackson-bom)
 

src/main/java/tools/jackson/dataformat/xml/XmlFactory.java

@@ -388,25 +388,15 @@ protected JsonGenerator _createGenerator(ObjectWriteContext writeCtxt,
     {
         // Only care about features and pretty-printer, for now;
         // may add CharacterEscapes in future?
-        
-        return new ToXmlGenerator(writeCtxt, ioCtxt,
-                writeCtxt.getStreamWriteFeatures(_streamWriteFeatures),
-                writeCtxt.getFormatWriteFeatures(_formatWriteFeatures),
-                _createXmlWriter(out),
-                _xmlPrettyPrinter(writeCtxt),
-                _nameProcessor);
-    }
 
+        return _toXmlGenerator(writeCtxt, ioCtxt, _createXmlWriter(out));
+    }
+    
     @Override
     protected JsonGenerator _createUTF8Generator(ObjectWriteContext writeCtxt,
             IOContext ioCtxt, OutputStream out)
     {
-        return new ToXmlGenerator(writeCtxt, ioCtxt,
-                writeCtxt.getStreamWriteFeatures(_streamWriteFeatures),
-                writeCtxt.getFormatWriteFeatures(_formatWriteFeatures),
-                _createXmlWriter(out),
-                _xmlPrettyPrinter(writeCtxt),
-                _nameProcessor);
+        return _toXmlGenerator(writeCtxt, ioCtxt, _createXmlWriter(out));
     }
 
     private final XmlPrettyPrinter _xmlPrettyPrinter(ObjectWriteContext writeCtxt)
@@ -423,6 +413,19 @@ private final XmlPrettyPrinter _xmlPrettyPrinter(ObjectWriteContext writeCtxt)
         return (XmlPrettyPrinter) pp;
     }
 
+    /**
+     * Overridable method to allow using custom FromXmlParser sub-classes.
+     */
+    protected ToXmlGenerator _toXmlGenerator(ObjectWriteContext writeCtxt, IOContext ioCtxt,
+            XMLStreamWriter sw) {
+        return new ToXmlGenerator(writeCtxt, ioCtxt,
+                writeCtxt.getStreamWriteFeatures(_streamWriteFeatures),
+                writeCtxt.getFormatWriteFeatures(_formatWriteFeatures),
+                sw,
+                _xmlPrettyPrinter(writeCtxt),
+                _nameProcessor);
+    }
+
     /*
     /**********************************************************************
     /* Extended public API, mostly for XmlMapper
@@ -442,11 +445,9 @@ public FromXmlParser createParser(ObjectReadContext readCtxt,
         }
 
         // false -> not managed
-        return new FromXmlParser(readCtxt,
+        return _fromXmlParser(readCtxt,
                 _createContext(_createContentReference(sr), false),
-                readCtxt.getStreamReadFeatures(_streamReadFeatures),
-                readCtxt.getFormatReadFeatures(_formatReadFeatures),
-                sr, _nameProcessor, _cfgNameForTextElement);
+                sr);
     }
 
     /**
@@ -459,11 +460,7 @@ public ToXmlGenerator createGenerator(ObjectWriteContext writeCtxt,
     {
         sw = _initializeXmlWriter(sw);
         IOContext ioCtxt = _createContext(_createContentReference(sw), false);
-        return new ToXmlGenerator(writeCtxt, ioCtxt,
-                writeCtxt.getStreamWriteFeatures(_streamWriteFeatures),
-                writeCtxt.getFormatWriteFeatures(_formatWriteFeatures),
-                sw,
-                _xmlPrettyPrinter(writeCtxt), _nameProcessor);
+        return _toXmlGenerator(writeCtxt, ioCtxt, sw);
     }
 
     /*
@@ -482,11 +479,7 @@ protected FromXmlParser _createParser(ObjectReadContext readCtxt, IOContext ioCt
         } catch (XMLStreamException e) {
             return StaxUtil.throwAsReadException(e, null);
         }
-        sr = _initializeXmlReader(sr);
-        return new FromXmlParser(readCtxt, ioCtxt,
-                readCtxt.getStreamReadFeatures(_streamReadFeatures),
-                readCtxt.getFormatReadFeatures(_formatReadFeatures),
-                sr, _nameProcessor, _cfgNameForTextElement);
+        return _fromXmlParser(readCtxt, ioCtxt, _initializeXmlReader(sr));
     }
 
     @Override
@@ -499,11 +492,7 @@ protected FromXmlParser _createParser(ObjectReadContext readCtxt, IOContext ioCt
         } catch (XMLStreamException e) {
             return StaxUtil.throwAsReadException(e, null);
         }
-        sr = _initializeXmlReader(sr);
-        return new FromXmlParser(readCtxt, ioCtxt,
-                readCtxt.getStreamReadFeatures(_streamReadFeatures),
-                readCtxt.getFormatReadFeatures(_formatReadFeatures),
-                sr, _nameProcessor, _cfgNameForTextElement);
+        return _fromXmlParser(readCtxt, ioCtxt, _initializeXmlReader(sr));
     }
 
     @Override
@@ -525,11 +514,7 @@ protected FromXmlParser _createParser(ObjectReadContext readCtxt, IOContext ioCt
         } catch (XMLStreamException e) {
             return StaxUtil.throwAsReadException(e, null);
         }
-        sr = _initializeXmlReader(sr);
-        return new FromXmlParser(readCtxt, ioCtxt,
-                readCtxt.getStreamReadFeatures(_streamReadFeatures),
-                readCtxt.getFormatReadFeatures(_formatReadFeatures),
-                sr, _nameProcessor, _cfgNameForTextElement);
+        return _fromXmlParser(readCtxt, ioCtxt, _initializeXmlReader(sr));
     }
 
     @Override
@@ -548,7 +533,14 @@ protected FromXmlParser _createParser(ObjectReadContext readCtxt, IOContext ioCt
         } catch (XMLStreamException e) {
             return StaxUtil.throwAsReadException(e, null);
         }
-        sr = _initializeXmlReader(sr);
+        return _fromXmlParser(readCtxt, ioCtxt, _initializeXmlReader(sr));
+    }
+
+    /**
+     * Overridable method to allow using custom FromXmlParser sub-classes.
+     */
+    protected FromXmlParser _fromXmlParser(ObjectReadContext readCtxt, IOContext ioCtxt,
+            XMLStreamReader sr) {
         return new FromXmlParser(readCtxt, ioCtxt,
                 readCtxt.getStreamReadFeatures(_streamReadFeatures),
                 readCtxt.getFormatReadFeatures(_formatReadFeatures),

src/main/java/tools/jackson/dataformat/xml/deser/FromXmlParser.java

@@ -4,6 +4,7 @@
 import java.io.Writer;
 import java.math.BigDecimal;
 import java.math.BigInteger;
+import java.util.Objects;
 import java.util.Set;
 
 import javax.xml.stream.XMLStreamException;
@@ -160,14 +161,28 @@ public FromXmlParser(ObjectReadContext readCtxt, IOContext ioCtxt,
             XMLStreamReader xmlReader,
             XmlNameProcessor nameProcessor,
             String nameForTextElement)
+    {
+        this(readCtxt, ioCtxt,
+                parserFeatures, xmlFeatures,
+                xmlReader,
+                new XmlTokenStream(xmlReader, ioCtxt.contentReference(),
+                        xmlFeatures, nameProcessor),
+                nameProcessor,
+                nameForTextElement);
+    }
+
+    public FromXmlParser(ObjectReadContext readCtxt, IOContext ioCtxt,
+            int parserFeatures, int xmlFeatures,
+            XMLStreamReader xmlReader,
+            XmlTokenStream tokenStream,
+            XmlNameProcessor nameProcessor,
+            String nameForTextElement)
     {
         super(readCtxt, ioCtxt, parserFeatures);
         _formatFeatures = xmlFeatures;
         _streamReadContext = XmlReadContext.createRootContext(-1, -1);
-        _xmlTokens = new XmlTokenStream(xmlReader, ioCtxt.contentReference(),
-                    _formatFeatures, nameProcessor);
+        _xmlTokens = Objects.requireNonNull(tokenStream, "xmlTokenStream cannot be null");
         _cfgNameForTextElement = nameForTextElement;
-
         final int firstToken;
         try {
             firstToken = _xmlTokens.initialize();