This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch DOXIA-614/support-source-reference-in-doxia-parser in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
commit bf0de3a946fb02bd2589e28b84f1714c2d1f644e Author: Sylwester Lachiewicz <[email protected]> AuthorDate: Sun May 30 13:29:44 2021 +0200 [DOXIA-614] Make Parser::parse(Reader,Sink,String) the default method for modules --- .../apache/maven/doxia/parser/AbstractParser.java | 23 +++++++++++++++++++--- .../maven/doxia/parser/AbstractXmlParser.java | 14 +------------ .../maven/doxia/parser/Xhtml5BaseParser.java | 4 ++-- .../apache/maven/doxia/parser/XhtmlBaseParser.java | 4 ++-- .../apache/maven/doxia/module/fml/FmlParser.java | 4 ++-- .../doxia/module/markdown/MarkdownParser.java | 2 +- .../apache/maven/doxia/module/xdoc/XdocParser.java | 4 ++-- .../maven/doxia/module/xhtml/XhtmlParser.java | 4 ++-- .../maven/doxia/module/xhtml5/Xhtml5Parser.java | 4 ++-- 9 files changed, 34 insertions(+), 29 deletions(-) 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 index 72100c6..8520e43 100644 --- 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 @@ public abstract class AbstractParser 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 index fd615c1..c0b1ddb 100644 --- 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 @@ public abstract class AbstractXmlParser // 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 index 5dfc757..dd10f58 100644 --- 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 index 57049e3..411b045 100644 --- 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 index 6fc121b..da334a1 100644 --- 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 class FmlParser 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 index 37a41a5..33057ea 100644 --- 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 class MarkdownParser /** {@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 index 6efa2b5..e1b8184 100644 --- 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 class XdocParser 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 index 470fc2f..fbeeb9a 100644 --- 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 @@ public class XhtmlParser } /** {@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 class XhtmlParser 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 index a1cd434..cf79171 100644 --- 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 @@ public class Xhtml5Parser } /** {@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 class Xhtml5Parser try { - super.parse( new StringReader( sourceContent ), sink ); + super.parse( new StringReader( sourceContent ), sink, reference ); } finally {
