[DOXIA-614] Make Parser::parse(Reader,Sink,String) the default method for modules

slachiewicz · slachiewicz · commit 64ddf82fc668 · 2021-05-30T14:31:08.000+02:00
Closes #35
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
@@ -179,15 +179,32 @@ protected File getBasedir()
     public void parse( String string, Sink sink )
         throws ParseException
     {
-        parse( new StringReader( string ), sink );
+        this.parse( string, sink, null );
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Convenience method to parse an arbitrary string and emit events into the given sink.
+     *
+     * @param string a string that provides the source input
+     * @param sink a sink that consumes the Doxia events
+     * @param reference a string containing the reference to the source of the input string (e.g. filename)
+     * @throws org.apache.maven.doxia.parser.ParseException if the string could not be parsed
+     * @since 1.10
+     */
+    public void parse( String string, Sink sink, String reference )
+        throws ParseException
+    {
+        parse( new StringReader( string ), sink, reference );
     }
 
     /** {@inheritDoc} */
     @Override
-    public void parse( Reader source, Sink sink, String reference )
+    public void parse( Reader source, Sink sink )
         throws ParseException
     {
-        parse( source, sink );
+        parse( source, sink, null );
     }
 
     /**
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
@@ -100,7 +100,7 @@ public abstract class AbstractXmlParser
     private boolean validate = false;
 
     /** {@inheritDoc} */
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         init();
@@ -166,18 +166,6 @@ protected void initXmlParser( XmlPullParser parser )
         // nop
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * Convenience method to parse an arbitrary string and emit any xml events into the given sink.
-     */
-    @Override
-    public void parse( String string, Sink sink )
-        throws ParseException
-    {
-        super.parse( string, sink );
-    }
-
     /** {@inheritDoc} */
     @Override
     public final int getType()
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
@@ -81,14 +81,14 @@ public class Xhtml5BaseParser
 
     /** {@inheritDoc} */
     @Override
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         init();
 
         try
         {
-            super.parse( source, sink );
+            super.parse( source, sink, reference );
         }
         finally
         {
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java b/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java
@@ -82,14 +82,14 @@ public class XhtmlBaseParser
 
     /** {@inheritDoc} */
     @Override
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         init();
 
         try
         {
-            super.parse( source, sink );
+            super.parse( source, sink, reference );
         }
         finally
         {
diff --git a/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java b/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java
@@ -89,7 +89,7 @@ public class FmlParser
     private Map<String, Object> macroParameters = new HashMap<>();
 
     /** {@inheritDoc} */
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         this.faqs = null;
@@ -118,7 +118,7 @@ public void parse( Reader source, Sink sink )
             this.faqs = new Faqs();
 
             // this populates faqs
-            super.parse( tmp, sink );
+            super.parse( tmp, sink, reference );
 
             writeFaqs( sink );
         }
diff --git a/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java b/doxia-modules/doxia-module-markdown/src/main/java/org/apache/maven/doxia/module/markdown/MarkdownParser.java
@@ -163,7 +163,7 @@ public int getType()
 
     /** {@inheritDoc} */
     @Override
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         try
diff --git a/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java b/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
@@ -85,7 +85,7 @@ public class XdocParser
     private boolean hasTitle;
 
     /** {@inheritDoc} */
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         this.sourceContent = null;
@@ -110,7 +110,7 @@ public void parse( Reader source, Sink sink )
 
         try
         {
-            super.parse( new StringReader( sourceContent ), sink );
+            super.parse( new StringReader( sourceContent ), sink, reference );
         }
         finally
         {
diff --git a/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlParser.java b/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlParser.java
@@ -333,7 +333,7 @@ protected void init()
     }
 
     /** {@inheritDoc} */
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         this.sourceContent = null;
@@ -355,7 +355,7 @@ public void parse( Reader source, Sink sink )
 
         try
         {
-            super.parse( new StringReader( sourceContent ), sink );
+            super.parse( new StringReader( sourceContent ), sink, reference );
         }
         finally
         {
diff --git a/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java b/doxia-modules/doxia-module-xhtml5/src/main/java/org/apache/maven/doxia/module/xhtml5/Xhtml5Parser.java
@@ -334,7 +334,7 @@ protected void init()
     }
 
     /** {@inheritDoc} */
-    public void parse( Reader source, Sink sink )
+    public void parse( Reader source, Sink sink, String reference )
         throws ParseException
     {
         this.sourceContent = null;
@@ -356,7 +356,7 @@ public void parse( Reader source, Sink sink )
 
         try
         {
-            super.parse( new StringReader( sourceContent ), sink );
+            super.parse( new StringReader( sourceContent ), sink, reference );
         }
         finally
         {

Original file line number	Diff line number	Diff line change
`@@ -81,14 +81,14 @@ public class Xhtml5BaseParser`
`81`	`81`
`82`	`82`	`/** {@inheritDoc} */`
`83`	`83`	`@Override`
`84`		`- public void parse( Reader source, Sink sink )`
	`84`	`+ public void parse( Reader source, Sink sink, String reference )`
`85`	`85`	`throws ParseException`
`86`	`86`	`{`
`87`	`87`	`init();`
`88`	`88`
`89`	`89`	`try`
`90`	`90`	`{`
`91`		`- super.parse( source, sink );`
	`91`	`+ super.parse( source, sink, reference );`
`92`	`92`	`}`
`93`	`93`	`finally`
`94`	`94`	`{`
Original file line number	Diff line number	Diff line change
`@@ -82,14 +82,14 @@ public class XhtmlBaseParser`
`82`	`82`
`83`	`83`	`/** {@inheritDoc} */`
`84`	`84`	`@Override`
`85`		`- public void parse( Reader source, Sink sink )`
	`85`	`+ public void parse( Reader source, Sink sink, String reference )`
`86`	`86`	`throws ParseException`
`87`	`87`	`{`
`88`	`88`	`init();`
`89`	`89`
`90`	`90`	`try`
`91`	`91`	`{`
`92`		`- super.parse( source, sink );`
	`92`	`+ super.parse( source, sink, reference );`
`93`	`93`	`}`
`94`	`94`	`finally`
`95`	`95`	`{`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ public class FmlParser`
`89`	`89`	`private Map<String, Object> macroParameters = new HashMap<>();`
`90`	`90`
`91`	`91`	`/** {@inheritDoc} */`
`92`		`- public void parse( Reader source, Sink sink )`
	`92`	`+ public void parse( Reader source, Sink sink, String reference )`
`93`	`93`	`throws ParseException`
`94`	`94`	`{`
`95`	`95`	`this.faqs = null;`
`@@ -118,7 +118,7 @@ public void parse( Reader source, Sink sink )`
`118`	`118`	`this.faqs = new Faqs();`
`119`	`119`
`120`	`120`	`// this populates faqs`
`121`		`- super.parse( tmp, sink );`
	`121`	`+ super.parse( tmp, sink, reference );`
`122`	`122`
`123`	`123`	`writeFaqs( sink );`
`124`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,7 @@ public int getType()`
`163`	`163`
`164`	`164`	`/** {@inheritDoc} */`
`165`	`165`	`@Override`
`166`		`- public void parse( Reader source, Sink sink )`
	`166`	`+ public void parse( Reader source, Sink sink, String reference )`
`167`	`167`	`throws ParseException`
`168`	`168`	`{`
`169`	`169`	`try`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public class XdocParser`
`85`	`85`	`private boolean hasTitle;`
`86`	`86`
`87`	`87`	`/** {@inheritDoc} */`
`88`		`- public void parse( Reader source, Sink sink )`
	`88`	`+ public void parse( Reader source, Sink sink, String reference )`
`89`	`89`	`throws ParseException`
`90`	`90`	`{`
`91`	`91`	`this.sourceContent = null;`
`@@ -110,7 +110,7 @@ public void parse( Reader source, Sink sink )`
`110`	`110`
`111`	`111`	`try`
`112`	`112`	`{`
`113`		`- super.parse( new StringReader( sourceContent ), sink );`
	`113`	`+ super.parse( new StringReader( sourceContent ), sink, reference );`
`114`	`114`	`}`
`115`	`115`	`finally`
`116`	`116`	`{`
Original file line number	Diff line number	Diff line change
`@@ -333,7 +333,7 @@ protected void init()`
`333`	`333`	`}`
`334`	`334`
`335`	`335`	`/** {@inheritDoc} */`
`336`		`- public void parse( Reader source, Sink sink )`
	`336`	`+ public void parse( Reader source, Sink sink, String reference )`
`337`	`337`	`throws ParseException`
`338`	`338`	`{`
`339`	`339`	`this.sourceContent = null;`
`@@ -355,7 +355,7 @@ public void parse( Reader source, Sink sink )`
`355`	`355`
`356`	`356`	`try`
`357`	`357`	`{`
`358`		`- super.parse( new StringReader( sourceContent ), sink );`
	`358`	`+ super.parse( new StringReader( sourceContent ), sink, reference );`
`359`	`359`	`}`
`360`	`360`	`finally`
`361`	`361`	`{`
Original file line number	Diff line number	Diff line change
`@@ -334,7 +334,7 @@ protected void init()`
`334`	`334`	`}`
`335`	`335`
`336`	`336`	`/** {@inheritDoc} */`
`337`		`- public void parse( Reader source, Sink sink )`
	`337`	`+ public void parse( Reader source, Sink sink, String reference )`
`338`	`338`	`throws ParseException`
`339`	`339`	`{`
`340`	`340`	`this.sourceContent = null;`
`@@ -356,7 +356,7 @@ public void parse( Reader source, Sink sink )`
`356`	`356`
`357`	`357`	`try`
`358`	`358`	`{`
`359`		`- super.parse( new StringReader( sourceContent ), sink );`
	`359`	`+ super.parse( new StringReader( sourceContent ), sink, reference );`
`360`	`360`	`}`
`361`	`361`	`finally`
`362`	`362`	`{`